OpenGrok

$NetBSD: OSSL_STORE_expect.3,v 1.1.1.1 2023/04/18 14:19:14 christos Exp $

Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)

Standard preamble:
========================================================================
..

..

.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "OSSL_STORE_expect 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
.nh OSSL_STORE_expect, OSSL_STORE_supports_search, OSSL_STORE_find \- Specify what object type is expected libcrypto, -lcrypto Header "SYNOPSIS" .Vb 1 #include <openssl/store.h> \& int OSSL_STORE_expect(OSSL_STORE_CTX *ctx, int expected_type); \& int OSSL_STORE_supports_search(OSSL_STORE_CTX *ctx, int criterion_type); \& int OSSL_STORE_find(OSSL_STORE_CTX *ctx, OSSL_STORE_SEARCH *search); .Ve Header "DESCRIPTION" \fBOSSL_STORE_expect() helps applications filter what OSSL_STORE_load() returns by specifying a \s-1OSSL_STORE_INFO\s0 type. For example, if \*(C`file:/foo/bar/store.pem\*(C' contains several different objects and only the certificates are interesting, the application can simply say that it expects the type \s-1OSSL_STORE_INFO_CERT\s0. All known object types (see \*(L"\s-1SUPPORTED OBJECTS\*(R"\s0 in \s-1OSSL_STORE_INFO\s0\|(3)) except for \s-1OSSL_STORE_INFO_NAME\s0 are supported.

\fBOSSL_STORE_find() helps applications specify a criterion for a more fine grained search of objects.

\fBOSSL_STORE_supports_search() checks if the loader of the given \s-1OSSL_STORE\s0 context supports the given search type. See \*(L"\s-1SUPPORTED CRITERION TYPES\*(R"\s0 in \s-1OSSL_STORE_SEARCH\s0 for information on the supported search criterion types.

\fBOSSL_STORE_expect() and OSSL_STORE_find must be called before the first \fBOSSL_STORE_load() of a given session, or they will fail.

Header "NOTES" If a more elaborate filter is required by the application, a better choice would be to use a post-processing function. See OSSL_STORE_open\|(3) for more information.

However, some loaders may take advantage of the knowledge of an expected type to make object retrieval more efficient, so if a single type is expected, this method is usually preferable.

Header "RETURN VALUES" \fBOSSL_STORE_expect() returns 1 on success, or 0 on failure.

\fBOSSL_STORE_supports_search() returns 1 if the criterion is supported, or 0 otherwise.

\fBOSSL_STORE_find() returns 1 on success, or 0 on failure.

Header "SEE ALSO" \fBossl_store\|(7), \s-1OSSL_STORE_INFO\s0\|(3), \s-1OSSL_STORE_SEARCH\s0\|(3), \fBOSSL_STORE_load\|(3) Header "HISTORY" \fBOSSL_STORE_expect(), OSSL_STORE_supports_search() and OSSL_STORE_find() were added in OpenSSL 1.1.1. Header "COPYRIGHT" Copyright 2018-2019 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.

Indexes created Wed Apr 22 00:22:44 UTC 2026