]> git.ipfire.org Git - thirdparty/openssl.git/blame - doc/crypto/i2d_CMS_bio_stream.pod
Fix nits in pod files.
[thirdparty/openssl.git] / doc / crypto / i2d_CMS_bio_stream.pod
CommitLineData
e33ffaca
DSH
1=pod
2
3=head1 NAME
4
1bc74519 5i2d_CMS_bio_stream - output CMS_ContentInfo structure in BER format.
e33ffaca
DSH
6
7=head1 SYNOPSIS
8
9 #include <openssl/cms.h>
10
11 int i2d_CMS_bio_stream(BIO *out, CMS_ContentInfo *cms, BIO *data, int flags);
12
13=head1 DESCRIPTION
14
15i2d_CMS_bio_stream() outputs a CMS_ContentInfo structure in BER format.
16
17It is otherwise identical to the function SMIME_write_CMS().
18
19=head1 NOTES
20
21This function is effectively a version of the i2d_CMS_bio() supporting
22streaming.
23
24=head1 BUGS
25
26The prefix "i2d" is arguably wrong because the function outputs BER format.
27
28=head1 RETURN VALUES
29
30i2d_CMS_bio_stream() returns 1 for success or 0 for failure.
31
32=head1 SEE ALSO
33
9b86974e
RS
34L<ERR_get_error(3)>, L<CMS_sign(3)>,
35L<CMS_verify(3)>, L<CMS_encrypt(3)>
36L<CMS_decrypt(3)>,
37L<SMIME_write_CMS(3)>,
38L<PEM_write_bio_CMS_stream(3)>
e33ffaca
DSH
39
40=head1 HISTORY
41
fb552ac6 42i2d_CMS_bio_stream() was added to OpenSSL 1.0.0
e33ffaca
DSH
43
44=cut
e2f92610
RS
45
46=head1 COPYRIGHT
47
48Copyright 2008-2016 The OpenSSL Project Authors. All Rights Reserved.
49
50Licensed under the OpenSSL license (the "License"). You may not use
51this file except in compliance with the License. You can obtain a copy
52in the file LICENSE in the source distribution or at
53L<https://www.openssl.org/source/license.html>.
54
55=cut