openssl/doc/crypto/i2d_PKCS7_bio_stream.pod
Matt Caswell aafbe1ccd2 Document updates from wiki.
PR#3071

The primary changes made are:
- Updates to the "NAME" section of many pages to correctly reflect the
functions defined on those pages. This section is automatically parsed
by the util/extract-names.pl script, so if it is not correct then
running "man" will not correctly locate the right manual pages.
- Updates to take account of where functions are now deprecated
- Full documentation of the ec sub-library
- A number of other typo corrections and other minor tweaks
2013-06-12 23:42:08 +01:00

44 lines
1,002 B
Text

=pod
=head1 NAME
i2d_PKCS7_bio_stream - output PKCS7 structure in BER format.
=head1 SYNOPSIS
#include <openssl/pkcs7.h>
int i2d_PKCS7_bio_stream(BIO *out, PKCS7 *p7, BIO *data, int flags);
=head1 DESCRIPTION
i2d_PKCS7_bio_stream() outputs a PKCS7 structure in BER format.
It is otherwise identical to the function SMIME_write_PKCS7().
=head1 NOTES
This function is effectively a version of the d2i_PKCS7_bio() supporting
streaming.
=head1 BUGS
The prefix "i2d" is arguably wrong because the function outputs BER format.
=head1 RETURN VALUES
i2d_PKCS7_bio_stream() returns 1 for success or 0 for failure.
=head1 SEE ALSO
L<ERR_get_error(3)|ERR_get_error(3)>, L<PKCS7_sign(3)|PKCS7_sign(3)>,
L<PKCS7_verify(3)|PKCS7_verify(3)>, L<PKCS7_encrypt(3)|PKCS7_encrypt(3)>
L<PKCS7_decrypt(3)|PKCS7_decrypt(3)>,
L<SMIME_write_PKCS7(3)|SMIME_write_PKCS7(3)>,
L<PEM_write_bio_PKCS7_stream(3)|PEM_write_bio_PKCS7_stream(3)>
=head1 HISTORY
i2d_PKCS7_bio_stream() was added to OpenSSL 1.0.0
=cut