]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
doc: EVP_PKEY_get_utf8/octet_string_param() clarify NULL buffer behavior
authorTomas Mraz <tomas@openssl.org>
Fri, 15 Oct 2021 12:50:17 +0000 (14:50 +0200)
committerTomas Mraz <tomas@openssl.org>
Fri, 22 Oct 2021 09:35:46 +0000 (11:35 +0200)
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/16843)

doc/man3/EVP_PKEY_gettable_params.pod

index b28ed6993993ad81bd9ce2e12769fa76032ae9b8..23ac4bd8b0679366d8607b0e25d7d32b7b8f93e9 100644 (file)
@@ -52,11 +52,15 @@ buffer I<str> of maximum size I<max_buf_sz> associated with a name of
 I<key_name>.  The maximum size must be large enough to accomodate the string
 value including a terminating NUL byte, or this function will fail.
 If I<out_len> is not NULL, I<*out_len> is set to the length of the string
-not including the terminating NUL byte.
+not including the terminating NUL byte. The required buffer size not including
+the terminating NUL byte can be obtained from I<*out_len> by calling the
+function with I<str> set to NULL.
 
 EVP_PKEY_get_octet_string_param() get a key I<pkey>'s octet string value into a
 buffer I<buf> of maximum size I<max_buf_sz> associated with a name of I<key_name>.
 If I<out_len> is not NULL, I<*out_len> is set to the length of the contents.
+The required buffer size can be obtained from I<*out_len> by calling the
+function with I<buf> set to NULL.
 
 =head1 NOTES