diff options
Diffstat (limited to 'src/lib/libcrypto/doc/i2d_CMS_bio_stream.pod')
| -rw-r--r-- | src/lib/libcrypto/doc/i2d_CMS_bio_stream.pod | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/src/lib/libcrypto/doc/i2d_CMS_bio_stream.pod b/src/lib/libcrypto/doc/i2d_CMS_bio_stream.pod new file mode 100644 index 0000000000..558bdd0812 --- /dev/null +++ b/src/lib/libcrypto/doc/i2d_CMS_bio_stream.pod | |||
| @@ -0,0 +1,44 @@ | |||
| 1 | =pod | ||
| 2 | |||
| 3 | =head1 NAME | ||
| 4 | |||
| 5 | i2d_CMS_bio_stream - output CMS_ContentInfo structure in BER format. | ||
| 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 | |||
| 15 | i2d_CMS_bio_stream() outputs a CMS_ContentInfo structure in BER format. | ||
| 16 | |||
| 17 | It is otherwise identical to the function SMIME_write_CMS(). | ||
| 18 | |||
| 19 | =head1 NOTES | ||
| 20 | |||
| 21 | This function is effectively a version of the i2d_CMS_bio() supporting | ||
| 22 | streaming. | ||
| 23 | |||
| 24 | =head1 BUGS | ||
| 25 | |||
| 26 | The prefix "i2d" is arguably wrong because the function outputs BER format. | ||
| 27 | |||
| 28 | =head1 RETURN VALUES | ||
| 29 | |||
| 30 | i2d_CMS_bio_stream() returns 1 for success or 0 for failure. | ||
| 31 | |||
| 32 | =head1 SEE ALSO | ||
| 33 | |||
| 34 | L<ERR_get_error(3)|ERR_get_error(3)>, L<CMS_sign(3)|CMS_sign(3)>, | ||
| 35 | L<CMS_verify(3)|CMS_verify(3)>, L<CMS_encrypt(3)|CMS_encrypt(3)> | ||
| 36 | L<CMS_decrypt(3)|CMS_decrypt(3)>, | ||
| 37 | L<SMIME_write_CMS(3)|SMIME_write_CMS(3)>, | ||
| 38 | L<PEM_write_bio_CMS_stream(3)|PEM_write_bio_CMS_stream(3)> | ||
| 39 | |||
| 40 | =head1 HISTORY | ||
| 41 | |||
| 42 | i2d_CMS_bio_stream() was added to OpenSSL 1.0.0 | ||
| 43 | |||
| 44 | =cut | ||
