diff options
author | Matt Caswell <matt@openssl.org> | 2020-09-24 10:42:23 +0100 |
---|---|---|
committer | Matt Caswell <matt@openssl.org> | 2020-10-01 09:25:20 +0100 |
commit | d8652be06e2778e8898453a391deb7253e1a35a2 (patch) | |
tree | fe40e22edb39642aa7ae633320c1900388f2e7ee /doc/man3/CMS_data_create.pod | |
parent | aedac96c1172ca9a9efe72e027e935504b599e2f (diff) |
Run the withlibctx.pl script
Automatically rename all instances of _with_libctx() to _ex() as per
our coding style.
Reviewed-by: Paul Dale <paul.dale@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/12970)
Diffstat (limited to 'doc/man3/CMS_data_create.pod')
-rw-r--r-- | doc/man3/CMS_data_create.pod | 15 |
1 files changed, 7 insertions, 8 deletions
diff --git a/doc/man3/CMS_data_create.pod b/doc/man3/CMS_data_create.pod index b64a7a1d46..2d361af6cc 100644 --- a/doc/man3/CMS_data_create.pod +++ b/doc/man3/CMS_data_create.pod @@ -2,21 +2,20 @@ =head1 NAME -CMS_data_create_with_libctx, CMS_data_create +CMS_data_create_ex, CMS_data_create - Create CMS Data object =head1 SYNOPSIS #include <openssl/cms.h> - CMS_ContentInfo *CMS_data_create_with_libctx(BIO *in, unsigned int flags, - OPENSSL_CTX *libctx, - const char *propq); + CMS_ContentInfo *CMS_data_create_ex(BIO *in, unsigned int flags, + OPENSSL_CTX *libctx, const char *propq); CMS_ContentInfo *CMS_data_create(BIO *in, unsigned int flags); =head1 DESCRIPTION -CMS_data_create_with_libctx() creates a B<CMS_ContentInfo> structure +CMS_data_create_ex() creates a B<CMS_ContentInfo> structure with a type B<NID_pkcs7_data>. The data is supplied via the I<in> BIO. The library context I<libctx> and the property query I<propq> are used when retrieving algorithms from providers. The I<flags> field supports the @@ -25,13 +24,13 @@ specified. The B<CMS_ContentInfo> structure can be freed using L<CMS_ContentInfo_free(3)>. -CMS_data_create() is similar to CMS_data_create_with_libctx() +CMS_data_create() is similar to CMS_data_create_ex() but uses default values of NULL for the library context I<libctx> and the property query I<propq>. =head1 RETURN VALUES -If the allocation fails, CMS_data_create_with_libctx() and CMS_data_create() +If the allocation fails, CMS_data_create_ex() and CMS_data_create() return NULL and set an error code that can be obtained by L<ERR_get_error(3)>. Otherwise they return a pointer to the newly allocated structure. @@ -41,7 +40,7 @@ L<ERR_get_error(3)>, L<CMS_final(3)> head1 HISTORY -The CMS_data_create_with_libctx() method was added in OpenSSL 3.0. +The CMS_data_create_ex() method was added in OpenSSL 3.0. =head1 COPYRIGHT |