summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorTomas Mraz <tomas@openssl.org>2022-01-05 11:18:27 +0100
committerTomas Mraz <tomas@openssl.org>2022-02-07 16:28:27 +0100
commitf6f4d1cc00a557232955867b6c04f767e8b5a12e (patch)
tree6d9cf700ce4d99c564a7070d591e546d06350970 /doc
parent25a0a44dc6223e515f5e91e41798cccf09c5612b (diff)
doc: Add hint to use EVP_PKEY_get_bn_param to retrieve big integers
Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/17423)
Diffstat (limited to 'doc')
-rw-r--r--doc/man3/EVP_PKEY_gettable_params.pod6
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/man3/EVP_PKEY_gettable_params.pod b/doc/man3/EVP_PKEY_gettable_params.pod
index 383ca6eb58..c6a3b43cd3 100644
--- a/doc/man3/EVP_PKEY_gettable_params.pod
+++ b/doc/man3/EVP_PKEY_gettable_params.pod
@@ -47,10 +47,12 @@ value that is negative or does not fit into a native C B<size_t> type using
EVP_PKEY_get_size_t_param() will also fail.
EVP_PKEY_get_int_param() retrieves a key I<pkey> integer value I<*out>
-associated with a name of I<key_name>.
+associated with a name of I<key_name> if it fits into C<int> type. For
+parameters that do not fit into C<int> use EVP_PKEY_get_bn_param().
EVP_PKEY_get_size_t_param() retrieves a key I<pkey> size_t value I<*out>
-associated with a name of I<key_name>.
+associated with a name of I<key_name> if it fits into C<size_t> type. For
+parameters that do not fit into C<size_t> use EVP_PKEY_get_bn_param().
EVP_PKEY_get_bn_param() retrieves a key I<pkey> BIGNUM value I<**bn>
associated with a name of I<key_name>. If I<*bn> is NULL then the BIGNUM