Debian Codegraph @

upstream/debian-unstable/man3/OSSL_STORE_attach.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "OSSL_STORE_ATTACH 3SSL"
58 .TH OSSL_STORE_ATTACH 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 OSSL_STORE_attach \- Functions to read objects from a BIO
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/store.h>
69 \&
70 \& OSSL_STORE_CTX *OSSL_STORE_attach(BIO *bio, const char *scheme,
71 \& OSSL_LIB_CTX *libctx, const char *propq,
72 \& const UI_METHOD *ui_method, void *ui_data,
73 \& const OSSL_PARAM params[],
74 \& OSSL_STORE_post_process_info_fn post_process,
75 \& void *post_process_data);
76 .Ve
77 .SH DESCRIPTION
78 .IX Header "DESCRIPTION"
79 \&\fBOSSL_STORE_attach()\fR works like \fBOSSL_STORE_open\fR\|(3), except it takes a \fBBIO\fR
80 \&\fIbio\fR instead of a \fIuri\fR, along with a \fIscheme\fR to determine what loader
81 should be used to process the data. The reference count of the \fBBIO\fR object
82 is increased by 1 if the call is successful.
83 .SH "RETURN VALUES"
84 .IX Header "RETURN VALUES"
85 \&\fBOSSL_STORE_attach()\fR returns a pointer to a \fBOSSL_STORE_CTX\fR on success, or
86 NULL on failure.
87 .SH "SEE ALSO"
88 .IX Header "SEE ALSO"
89 \&\fBossl_store\fR\|(7), \fBOSSL_STORE_open\fR\|(3)
90 .SH HISTORY
91 .IX Header "HISTORY"
92 \&\fBOSSL_STORE_attach()\fR was added in OpenSSL 3.0.
93 .SH COPYRIGHT
94 .IX Header "COPYRIGHT"
95 Copyright 2020\-2021 The OpenSSL Project Authors. All Rights Reserved.
96 .PP
97 Licensed under the Apache License 2.0 (the "License"). You may not use
98 this file except in compliance with the License. You can obtain a copy
99 in the file LICENSE in the source distribution or at
100 <https://www.openssl.org/source/license.html>.