X-Git-Url: https://git.openssl.org/?p=openssl.git;a=blobdiff_plain;f=doc%2Fman3%2FOSSL_PARAM_int.pod;h=991b3d1212fa204db23a41b4066662508c4428ca;hp=742e8d57745942e1d1ad428d257d3b30165e7505;hb=8f3b8fd6f45fc5f2ab924011908a1e66c2dba462;hpb=d4d28783473e5b4417068258f2553896ff618600 diff --git a/doc/man3/OSSL_PARAM_int.pod b/doc/man3/OSSL_PARAM_int.pod index 742e8d5774..991b3d1212 100644 --- a/doc/man3/OSSL_PARAM_int.pod +++ b/doc/man3/OSSL_PARAM_int.pod @@ -198,6 +198,8 @@ Type coercion takes place as discussed in the NOTES section. OSSL_PARAM_set_TYPE() stores a value B of type B into the parameter B

. +If the parameter's I field is NULL, then only its I field +will be assigned the size the parameter's I buffer should have. Type coercion takes place as discussed in the NOTES section. OSSL_PARAM_get_BN() retrieves a BIGNUM from the parameter pointed to by B

. @@ -205,6 +207,8 @@ The BIGNUM referenced by B is updated and is allocated if B<*val> is B. OSSL_PARAM_set_BN() stores the BIGNUM B into the parameter B

. +If the parameter's I field is NULL, then only its I field +will be assigned the size the parameter's I buffer should have. OSSL_PARAM_get_utf8_string() retrieves a UTF8 string from the parameter pointed to by B

. @@ -215,6 +219,8 @@ If memory is allocated by this function, it must be freed by the caller. OSSL_PARAM_set_utf8_string() sets a UTF8 string from the parameter pointed to by B

to the value referenced by B. +If the parameter's I field is NULL, then only its I field +will be assigned the size the parameter's I buffer should have. OSSL_PARAM_get_octet_string() retrieves an OCTET string from the parameter pointed to by B

. @@ -225,6 +231,8 @@ If memory is allocated by this function, it must be freed by the caller. OSSL_PARAM_set_octet_string() sets an OCTET string from the parameter pointed to by B

to the value referenced by B. +If the parameter's I field is NULL, then only its I field +will be assigned the size the parameter's I buffer should have. OSSL_PARAM_get_utf8_ptr() retrieves the UTF8 string pointer from the parameter referenced by B

and stores it in B<*val>. @@ -260,9 +268,9 @@ representable by the target type or parameter. Apart from that, the functions must be used appropriately for the expected type of the parameter. -For OSSL_PARAM_get_utf8_ptr() and OSSL_PARAM_get_octet_ptr(), B -is not relevant if the purpose is to send the B array to a -I, i.e. to get parameter data back. +For OSSL_PARAM_construct_utf8_ptr() and OSSL_PARAM_consstruct_octet_ptr(), +B is not relevant if the purpose is to send the B array +to a I, i.e. to get parameter data back. In that case, B can safely be given zero. See L for further information on the possible purposes.