X-Git-Url: https://git.openssl.org/?p=openssl.git;a=blobdiff_plain;f=doc%2Fman3%2FOSSL_PARAM_TYPE.pod;h=4585f25acd5aee695a7ddf2e66510f95eeec13eb;hp=dd887f3089596c61d0be8cd70330cbe7a86c9975;hb=c54492ecf8331fd87f6ac163f9fc5b576af128e8;hpb=195852fefc1ef090977ed3cc3334f1dfbd6bac34 diff --git a/doc/man3/OSSL_PARAM_TYPE.pod b/doc/man3/OSSL_PARAM_TYPE.pod index dd887f3089..4585f25acd 100644 --- a/doc/man3/OSSL_PARAM_TYPE.pod +++ b/doc/man3/OSSL_PARAM_TYPE.pod @@ -44,9 +44,9 @@ OSSL_PARAM_set_octet_ptr OSSL_PARAM OSSL_PARAM_construct_octet_string(const char *key, void *buf, size_t bsize, size_t *rsize); OSSL_PARAM OSSL_PARAM_construct_utf8_ptr(const char *key, char **buf, - size_t *rsize); + size_t bsize, size_t *rsize); OSSL_PARAM OSSL_PARAM_construct_octet_ptr(const char *key, void **buf, - size_t *rsize); + size_t bsize, size_t *rsize); OSSL_PARAM OSSL_PARAM_construct_end(void); OSSL_PARAM *OSSL_PARAM_locate(OSSL_PARAM *array, const char *key); @@ -173,13 +173,13 @@ size B is created. OSSL_PARAM_construct_utf8_ptr() is a function that constructes a UTF string pointer OSSL_PARAM structure. -A parameter with name B, storage pointer B<*buf> and return size B -is created. +A parameter with name B, storage pointer B<*buf>, size B and +return size B is created. OSSL_PARAM_construct_octet_ptr() is a function that constructes an OCTET string pointer OSSL_PARAM structure. -A parameter with name B, storage pointer B<*buf> and return size B -is created. +A parameter with name B, storage pointer B<*buf>, size B and +return size B is created. OSSL_PARAM_construct_end() is a function that constructs the terminating OSSL_PARAM structure. @@ -254,6 +254,13 @@ Integral types will be widened and sign extended as required. 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. +In that case, B can safely be given zero. +See L for further information on the +possible purposes. + =head1 EXAMPLES Reusing the examples from L to just show how