diff options
| author | Tomas Mraz <tomas@openssl.org> | 2021-10-15 14:50:17 +0200 |
|---|---|---|
| committer | Tomas Mraz <tomas@openssl.org> | 2021-10-22 11:36:03 +0200 |
| commit | d9f8032ea6c414fbcf91ed541059dd6c32a9abc6 (patch) | |
| tree | f77e49a90bcf8901331f0efe27b66f0938dd1223 /doc/man3 | |
| parent | d86d703711c6431b611afabc2de3b174fbf8ec36 (diff) | |
doc: EVP_PKEY_get_utf8/octet_string_param() clarify NULL buffer behavior
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/16843)
(cherry picked from commit cde5a12d5e83ba0d7c5b2dd7bafa4d2abe2d45bf)
Diffstat (limited to 'doc/man3')
| -rw-r--r-- | doc/man3/EVP_PKEY_gettable_params.pod | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/man3/EVP_PKEY_gettable_params.pod b/doc/man3/EVP_PKEY_gettable_params.pod index b28ed69939..23ac4bd8b0 100644 --- a/doc/man3/EVP_PKEY_gettable_params.pod +++ b/doc/man3/EVP_PKEY_gettable_params.pod @@ -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 |