CMS_final.pod 1.3 KB

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