diff options
author | Rich Salz <rsalz@openssl.org> | 2016-10-26 19:56:48 +0200 |
---|---|---|
committer | Rich Salz <rsalz@openssl.org> | 2016-10-26 19:59:52 +0200 |
commit | 99d63d4662e16afbeff49f29b48f1c87d5558ed0 (patch) | |
tree | 6512ff02cd93985526080f05ab2b5408235b19a9 /doc/man3/CMS_final.pod | |
parent | VMS: tell the C compiler to use the ISO C94 standard (diff) | |
download | openssl-99d63d4662e16afbeff49f29b48f1c87d5558ed0.tar.xz openssl-99d63d4662e16afbeff49f29b48f1c87d5558ed0.zip |
Move manpages to man[1357] structure.
Move manpages to manX directories
Add Windows/VMS install fix from Richard Levitte
Update README
Fix typo's
Remove some duplicates
Reviewed-by: Richard Levitte <levitte@openssl.org>
Diffstat (limited to 'doc/man3/CMS_final.pod')
-rw-r--r-- | doc/man3/CMS_final.pod | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/doc/man3/CMS_final.pod b/doc/man3/CMS_final.pod new file mode 100644 index 0000000000..264fe7bc3b --- /dev/null +++ b/doc/man3/CMS_final.pod @@ -0,0 +1,46 @@ +=pod + +=head1 NAME + +CMS_final - finalise a CMS_ContentInfo structure + +=head1 SYNOPSIS + + #include <openssl/cms.h> + + int CMS_final(CMS_ContentInfo *cms, BIO *data, BIO *dcont, unsigned int flags); + +=head1 DESCRIPTION + +CMS_final() finalises the structure B<cms>. It's purpose is to perform any +operations necessary on B<cms> (digest computation for example) and set the +appropriate fields. The parameter B<data> contains the content to be +processed. The B<dcont> parameter contains a BIO to write content to after +processing: this is only used with detached data and will usually be set to +NULL. + +=head1 NOTES + +This function will normally be called when the B<CMS_PARTIAL> flag is used. It +should only be used when streaming is not performed because the streaming +I/O functions perform finalisation operations internally. + +=head1 RETURN VALUES + +CMS_final() returns 1 for success or 0 for failure. + +=head1 SEE ALSO + +L<ERR_get_error(3)>, L<CMS_sign(3)>, +L<CMS_encrypt(3)> + +=head1 COPYRIGHT + +Copyright 2008-2016 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the OpenSSL license (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L<https://www.openssl.org/source/license.html>. + +=cut |