Blame doc/man3/CMS_final.pod

Packit c4476c
=pod
Packit c4476c
Packit c4476c
=head1 NAME
Packit c4476c
Packit c4476c
CMS_final - finalise a CMS_ContentInfo structure
Packit c4476c
Packit c4476c
=head1 SYNOPSIS
Packit c4476c
Packit c4476c
 #include <openssl/cms.h>
Packit c4476c
Packit c4476c
 int CMS_final(CMS_ContentInfo *cms, BIO *data, BIO *dcont, unsigned int flags);
Packit c4476c
Packit c4476c
=head1 DESCRIPTION
Packit c4476c
Packit c4476c
CMS_final() finalises the structure B<cms>. Its purpose is to perform any
Packit c4476c
operations necessary on B<cms> (digest computation for example) and set the
Packit c4476c
appropriate fields. The parameter B<data> contains the content to be
Packit c4476c
processed. The B<dcont> parameter contains a BIO to write content to after
Packit c4476c
processing: this is only used with detached data and will usually be set to
Packit c4476c
NULL.
Packit c4476c
Packit c4476c
=head1 NOTES
Packit c4476c
Packit c4476c
This function will normally be called when the B<CMS_PARTIAL> flag is used. It
Packit c4476c
should only be used when streaming is not performed because the streaming
Packit c4476c
I/O functions perform finalisation operations internally.
Packit c4476c
Packit c4476c
=head1 RETURN VALUES
Packit c4476c
Packit c4476c
CMS_final() returns 1 for success or 0 for failure.
Packit c4476c
Packit c4476c
=head1 SEE ALSO
Packit c4476c
Packit c4476c
L<ERR_get_error(3)>, L<CMS_sign(3)>,
Packit c4476c
L<CMS_encrypt(3)>
Packit c4476c
Packit c4476c
=head1 COPYRIGHT
Packit c4476c
Packit c4476c
Copyright 2008-2019 The OpenSSL Project Authors. All Rights Reserved.
Packit c4476c
Packit c4476c
Licensed under the OpenSSL license (the "License").  You may not use
Packit c4476c
this file except in compliance with the License.  You can obtain a copy
Packit c4476c
in the file LICENSE in the source distribution or at
Packit c4476c
L<https://www.openssl.org/source/license.html>.
Packit c4476c
Packit c4476c
=cut