diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/OSSL_PARAM_int.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/OSSL_PARAM_int.3 | 31 |
1 files changed, 17 insertions, 14 deletions
diff --git a/secure/lib/libcrypto/man/man3/OSSL_PARAM_int.3 b/secure/lib/libcrypto/man/man3/OSSL_PARAM_int.3 index ab3fe3452300..652b05940afc 100644 --- a/secure/lib/libcrypto/man/man3/OSSL_PARAM_int.3 +++ b/secure/lib/libcrypto/man/man3/OSSL_PARAM_int.3 @@ -1,5 +1,5 @@ .\" -*- mode: troff; coding: utf-8 -*- -.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) +.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -52,10 +52,13 @@ . \} .\} .rr rF +.\" +.\" Required to disable full justification in groff 1.23.0. +.if n .ds AD l .\" ======================================================================== .\" .IX Title "OSSL_PARAM_INT 3ossl" -.TH OSSL_PARAM_INT 3ossl 2025-09-30 3.5.4 OpenSSL +.TH OSSL_PARAM_INT 3ossl 2026-04-07 3.5.6 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -257,8 +260,8 @@ Type coercion takes place as discussed in the NOTES section. .PP \&\fBOSSL_PARAM_set_TYPE()\fR stores a value \fIval\fR of type \fR\f(BITYPE\fR\fB\fR into the parameter \fIp\fR. -If the parameter's \fIdata\fR field is NULL, then only its \fIreturn_size\fR field -will be assigned the size the parameter's \fIdata\fR buffer should have. +If the parameter\*(Aqs \fIdata\fR field is NULL, then only its \fIreturn_size\fR field +will be assigned the size the parameter\*(Aqs \fIdata\fR buffer should have. Type coercion takes place as discussed in the NOTES section. .PP \&\fBOSSL_PARAM_get_BN()\fR retrieves a BIGNUM from the parameter pointed to by \fIp\fR. @@ -266,8 +269,8 @@ The BIGNUM referenced by \fIval\fR is updated and is allocated if \fI*val\fR is NULL. .PP \&\fBOSSL_PARAM_set_BN()\fR stores the BIGNUM \fIval\fR into the parameter \fIp\fR. -If the parameter's \fIdata\fR field is NULL, then only its \fIreturn_size\fR field -will be assigned the size the parameter's \fIdata\fR buffer should have. +If the parameter\*(Aqs \fIdata\fR field is NULL, then only its \fIreturn_size\fR field +will be assigned the size the parameter\*(Aqs \fIdata\fR buffer should have. .PP \&\fBOSSL_PARAM_get_utf8_string()\fR retrieves a UTF8 string from the parameter pointed to by \fIp\fR. @@ -280,14 +283,14 @@ If memory is allocated by this function, it must be freed by the caller. .PP \&\fBOSSL_PARAM_set_utf8_string()\fR sets a UTF8 string from the parameter pointed to by \fIp\fR to the value referenced by \fIval\fR. -If the parameter's \fIdata\fR field isn't NULL, its \fIdata_size\fR must indicate +If the parameter\*(Aqs \fIdata\fR field isn\*(Aqt NULL, its \fIdata_size\fR must indicate that the buffer is large enough to accommodate the string that \fIval\fR points at, not including the terminating NUL byte, or this function will fail. -A terminating NUL byte is added only if the parameter's \fIdata_size\fR indicates +A terminating NUL byte is added only if the parameter\*(Aqs \fIdata_size\fR indicates the buffer is longer than the string length, otherwise the string will not be NUL terminated. -If the parameter's \fIdata\fR field is NULL, then only its \fIreturn_size\fR field -will be assigned the minimum size the parameter's \fIdata\fR buffer should have +If the parameter\*(Aqs \fIdata\fR field is NULL, then only its \fIreturn_size\fR field +will be assigned the minimum size the parameter\*(Aqs \fIdata\fR buffer should have to accommodate the string, not including a terminating NUL byte. .PP \&\fBOSSL_PARAM_get_octet_string()\fR retrieves an OCTET string from the parameter @@ -301,8 +304,8 @@ If memory is allocated by this function, it must be freed by the caller. .PP \&\fBOSSL_PARAM_set_octet_string()\fR sets an OCTET string from the parameter pointed to by \fIp\fR to the value referenced by \fIval\fR. -If the parameter's \fIdata\fR field is NULL, then only its \fIreturn_size\fR field -will be assigned the size the parameter's \fIdata\fR buffer should have. +If the parameter\*(Aqs \fIdata\fR field is NULL, then only its \fIreturn_size\fR field +will be assigned the size the parameter\*(Aqs \fIdata\fR buffer should have. .PP \&\fBOSSL_PARAM_get_utf8_ptr()\fR retrieves the UTF8 string pointer from the parameter referenced by \fIp\fR and stores it in \fI*val\fR. @@ -325,7 +328,7 @@ string. .PP \&\fBOSSL_PARAM_get_octet_string_ptr()\fR retrieves the pointer to a octet string from the parameter pointed to by \fIp\fR, and stores that pointer in \fI*val\fR, -along with the string's length in \fI*used_len\fR. +along with the string\*(Aqs length in \fI*used_len\fR. This is different from \fBOSSL_PARAM_get_octet_string()\fR, which copies the string. .PP @@ -395,7 +398,7 @@ This example is for setting parameters on some object: .SS "Example 2" .IX Subsection "Example 2" This example is for requesting parameters on some object, and also -demonstrates that the requester isn't obligated to request all +demonstrates that the requester isn\*(Aqt obligated to request all available parameters: .PP .Vb 7 |