Doc nits cleanup, round 2
[openssl.git] / doc / crypto / PEM_write_bio_PKCS7_stream.pod
1 =pod
2
3 =head1 NAME
4
5 PEM_write_bio_PKCS7_stream - output PKCS7 structure in PEM format.
6
7 =head1 SYNOPSIS
8
9  #include <openssl/pkcs7.h>
10  #include <openssl/pem.h>
11
12  int PEM_write_bio_PKCS7_stream(BIO *out, PKCS7 *p7, BIO *data, int flags);
13
14 =head1 DESCRIPTION
15
16 PEM_write_bio_PKCS7_stream() outputs a PKCS7 structure in PEM format.
17
18 It is otherwise identical to the function SMIME_write_PKCS7().
19
20 =head1 NOTES
21
22 This function is effectively a version of the PEM_write_bio_PKCS7() supporting
23 streaming.
24
25 =head1 RETURN VALUES
26
27 PEM_write_bio_PKCS7_stream() returns 1 for success or 0 for failure.
28
29 =head1 SEE ALSO
30
31 L<ERR_get_error(3)>, L<PKCS7_sign(3)>,
32 L<PKCS7_verify(3)>, L<PKCS7_encrypt(3)>
33 L<PKCS7_decrypt(3)>,
34 L<SMIME_write_PKCS7(3)>,
35 L<i2d_PKCS7_bio_stream(3)>
36
37 =head1 HISTORY
38
39 PEM_write_bio_PKCS7_stream() was added to OpenSSL 1.0.0
40
41 =head1 COPYRIGHT
42
43 Copyright 2007-2016 The OpenSSL Project Authors. All Rights Reserved.
44
45 Licensed under the OpenSSL license (the "License").  You may not use
46 this file except in compliance with the License.  You can obtain a copy
47 in the file LICENSE in the source distribution or at
48 L<https://www.openssl.org/source/license.html>.
49
50 =cut