X-Git-Url: https://git.openssl.org/?p=openssl.git;a=blobdiff_plain;f=doc%2Fman3%2FOSSL_PARAM_int.pod;h=7aa6b9377f9b7ca1a4aead65e73860d2f7a0e8d3;hp=b6faedb9111d52e43dcd4bb3d0fc19178432ede7;hb=6c689e58f70726cfa5533bc10f9669abce199fb8;hpb=33388b44b67145af2181b1e9528c381c8ea0d1b6 diff --git a/doc/man3/OSSL_PARAM_int.pod b/doc/man3/OSSL_PARAM_int.pod index b6faedb911..7aa6b9377f 100644 --- a/doc/man3/OSSL_PARAM_int.pod +++ b/doc/man3/OSSL_PARAM_int.pod @@ -3,31 +3,34 @@ =head1 NAME OSSL_PARAM_double, OSSL_PARAM_int, OSSL_PARAM_int32, OSSL_PARAM_int64, -OSSL_PARAM_long, OSSL_PARAM_size_t, OSSL_PARAM_uint, OSSL_PARAM_uint32, -OSSL_PARAM_uint64, OSSL_PARAM_ulong, OSSL_PARAM_BN, OSSL_PARAM_utf8_string, -OSSL_PARAM_octet_string, OSSL_PARAM_utf8_ptr, OSSL_PARAM_octet_ptr, +OSSL_PARAM_long, OSSL_PARAM_size_t, OSSL_PARAM_time_t, OSSL_PARAM_uint, +OSSL_PARAM_uint32, OSSL_PARAM_uint64, OSSL_PARAM_ulong, OSSL_PARAM_BN, +OSSL_PARAM_utf8_string, OSSL_PARAM_octet_string, OSSL_PARAM_utf8_ptr, +OSSL_PARAM_octet_ptr, OSSL_PARAM_END, OSSL_PARAM_construct_double, OSSL_PARAM_construct_int, OSSL_PARAM_construct_int32, OSSL_PARAM_construct_int64, OSSL_PARAM_construct_long, OSSL_PARAM_construct_size_t, -OSSL_PARAM_construct_uint, OSSL_PARAM_construct_uint32, -OSSL_PARAM_construct_uint64, OSSL_PARAM_construct_ulong, -OSSL_PARAM_construct_BN, OSSL_PARAM_construct_utf8_string, -OSSL_PARAM_construct_utf8_ptr, OSSL_PARAM_construct_octet_string, -OSSL_PARAM_construct_octet_ptr, OSSL_PARAM_construct_end, +OSSL_PARAM_construct_time_t, OSSL_PARAM_construct_uint, +OSSL_PARAM_construct_uint32, OSSL_PARAM_construct_uint64, +OSSL_PARAM_construct_ulong, OSSL_PARAM_construct_BN, +OSSL_PARAM_construct_utf8_string, OSSL_PARAM_construct_utf8_ptr, +OSSL_PARAM_construct_octet_string, OSSL_PARAM_construct_octet_ptr, +OSSL_PARAM_construct_end, OSSL_PARAM_locate, OSSL_PARAM_locate_const, OSSL_PARAM_get_double, OSSL_PARAM_get_int, OSSL_PARAM_get_int32, OSSL_PARAM_get_int64, OSSL_PARAM_get_long, OSSL_PARAM_get_size_t, -OSSL_PARAM_get_uint, OSSL_PARAM_get_uint32, OSSL_PARAM_get_uint64, -OSSL_PARAM_get_ulong, OSSL_PARAM_get_BN, OSSL_PARAM_get_utf8_string, -OSSL_PARAM_get_octet_string, OSSL_PARAM_get_utf8_ptr, -OSSL_PARAM_get_octet_ptr, +OSSL_PARAM_get_time_t, OSSL_PARAM_get_uint, OSSL_PARAM_get_uint32, +OSSL_PARAM_get_uint64, OSSL_PARAM_get_ulong, OSSL_PARAM_get_BN, +OSSL_PARAM_get_utf8_string, OSSL_PARAM_get_octet_string, +OSSL_PARAM_get_utf8_ptr, OSSL_PARAM_get_octet_ptr, OSSL_PARAM_set_double, OSSL_PARAM_set_int, OSSL_PARAM_set_int32, OSSL_PARAM_set_int64, OSSL_PARAM_set_long, OSSL_PARAM_set_size_t, -OSSL_PARAM_set_uint, OSSL_PARAM_set_uint32, OSSL_PARAM_set_uint64, -OSSL_PARAM_set_ulong, OSSL_PARAM_set_BN, OSSL_PARAM_set_utf8_string, -OSSL_PARAM_set_octet_string, OSSL_PARAM_set_utf8_ptr, -OSSL_PARAM_set_octet_ptr, OSSL_PARAM_UNMODIFIED +OSSL_PARAM_set_time_t, OSSL_PARAM_set_uint, OSSL_PARAM_set_uint32, +OSSL_PARAM_set_uint64, OSSL_PARAM_set_ulong, OSSL_PARAM_set_BN, +OSSL_PARAM_set_utf8_string, OSSL_PARAM_set_octet_string, +OSSL_PARAM_set_utf8_ptr, OSSL_PARAM_set_octet_ptr, +OSSL_PARAM_UNMODIFIED, OSSL_PARAM_modified, OSSL_PARAM_set_all_unmodified - OSSL_PARAM helpers =head1 SYNOPSIS @@ -38,9 +41,9 @@ OSSL_PARAM_set_octet_ptr, OSSL_PARAM_UNMODIFIED /* * TYPE in function names is one of: - * double, int, int32, int64, long, size_t, uint, uint32, uint64, ulong + * double, int, int32, int64, long, size_t, time_t, uint, uint32, uint64, ulong * Corresponding TYPE in function arguments is one of: - * double, int, int32_t, int64_t, long, size_t, unsigned int, uint32_t, + * double, int, int32_t, int64_t, long, size_t, time_t, unsigned int, uint32_t, * uint64_t, unsigned long */ @@ -93,8 +96,8 @@ OSSL_PARAM_set_octet_ptr, OSSL_PARAM_UNMODIFIED int OSSL_PARAM_set_octet_ptr(OSSL_PARAM *p, const void *val, size_t used_len); - int OSSL_PARAM_modified(const OSSL_PARAM *p); - void OSSL_PARAM_set_unmodified(OSSL_PARAM *p); + int OSSL_PARAM_modified(const OSSL_PARAM *param); + void OSSL_PARAM_set_all_unmodified(OSSL_PARAM *params); =head1 DESCRIPTION @@ -125,6 +128,10 @@ long int (long) =item * +time_t + +=item * + size_t =item * @@ -233,7 +240,9 @@ OSSL_PARAM_get_octet_string() retrieves an OCTET string from the parameter pointed to by B

. The OCTETs are either stored into B<*val> with a length limit of B or, in the case when B<*val> is B, memory is allocated and -B is ignored. +B is ignored. B<*used_len> is populated with the number of OCTETs +stored. If B is NULL then the OCTETS are not stored, but B<*used_len> is +still populated. 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 @@ -260,10 +269,11 @@ creation, via either the macros or construct calls, the I field is set to this. If the parameter is set using the calls defined herein, the I field is changed. -OSSL_PARAM_modified() queries if the parameter has been set or not using the -calls defined herein. +OSSL_PARAM_modified() queries if the parameter B has been set or not +using the calls defined herein. -OSSL_PARAM_set_unmodified() is used to reset unused indicator. +OSSL_PARAM_set_all_unmodified() resets the unused indicator for all parameters +in the array B. =head1 RETURN VALUES