Debian Codegraph @

upstream/debian-unstable/man3/PEM_write_bio_CMS_stream.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 "PEM_WRITE_BIO_CMS_STREAM 3SSL"
58 .TH PEM_WRITE_BIO_CMS_STREAM 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 PEM_write_bio_CMS_stream \- output CMS_ContentInfo structure in PEM format
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/cms.h>
69 \&
70 \& int PEM_write_bio_CMS_stream(BIO *out, CMS_ContentInfo *cms, BIO *data, int flags);
71 .Ve
72 .SH DESCRIPTION
73 .IX Header "DESCRIPTION"
74 \&\fBPEM_write_bio_CMS_stream()\fR outputs a CMS_ContentInfo structure in PEM format.
75 .PP
76 It is otherwise identical to the function \fBSMIME_write_CMS()\fR.
77 .SH NOTES
78 .IX Header "NOTES"
79 This function is effectively a version of the \fBPEM_write_bio_CMS()\fR supporting
80 streaming.
81 .SH "RETURN VALUES"
82 .IX Header "RETURN VALUES"
83 \&\fBPEM_write_bio_CMS_stream()\fR returns 1 for success or 0 for failure.
84 .SH "SEE ALSO"
85 .IX Header "SEE ALSO"
86 \&\fBERR_get_error\fR\|(3), \fBCMS_sign\fR\|(3),
87 \&\fBCMS_verify\fR\|(3), \fBCMS_encrypt\fR\|(3)
88 \&\fBCMS_decrypt\fR\|(3),
89 \&\fBPEM_write\fR\|(3),
90 \&\fBSMIME_write_CMS\fR\|(3),
91 \&\fBi2d_CMS_bio_stream\fR\|(3)
92 .SH HISTORY
93 .IX Header "HISTORY"
94 The \fBPEM_write_bio_CMS_stream()\fR function was added in OpenSSL 1.0.0.
95 .SH COPYRIGHT
96 .IX Header "COPYRIGHT"
97 Copyright 2008\-2016 The OpenSSL Project Authors. All Rights Reserved.
98 .PP
99 Licensed under the Apache License 2.0 (the "License"). You may not use
100 this file except in compliance with the License. You can obtain a copy
101 in the file LICENSE in the source distribution or at
102 <https://www.openssl.org/source/license.html>.