CMS_final.pod 1.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  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>. It's 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)|ERR_get_error(3)>, L<CMS_sign(3)|CMS_sign(3)>,
  22. L<CMS_encrypt(3)|CMS_encrypt(3)>
  23. =head1 HISTORY
  24. CMS_final() was added to OpenSSL 0.9.8
  25. =cut