diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/ERR_error_string.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/ERR_error_string.3 | 40 |
1 files changed, 24 insertions, 16 deletions
diff --git a/secure/lib/libcrypto/man/man3/ERR_error_string.3 b/secure/lib/libcrypto/man/man3/ERR_error_string.3 index f46a016d091a..7819eeebe7c6 100644 --- a/secure/lib/libcrypto/man/man3/ERR_error_string.3 +++ b/secure/lib/libcrypto/man/man3/ERR_error_string.3 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) +.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" Standard preamble: .\" ======================================================================== @@ -68,8 +68,6 @@ . \} .\} .rr rF -.\" -.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ @@ -132,14 +130,16 @@ .rm #[ #] #H #V #F C .\" ======================================================================== .\" -.IX Title "ERR_ERROR_STRING 3" -.TH ERR_ERROR_STRING 3 "2022-06-21" "1.1.1p" "OpenSSL" +.IX Title "ERR_ERROR_STRING 3ossl" +.TH ERR_ERROR_STRING 3ossl "2023-09-19" "3.0.11" "OpenSSL" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" -ERR_error_string, ERR_error_string_n, ERR_lib_error_string, ERR_func_error_string, ERR_reason_error_string \- obtain human\-readable error message +ERR_error_string, ERR_error_string_n, ERR_lib_error_string, +ERR_func_error_string, ERR_reason_error_string \- obtain human\-readable +error message .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 @@ -149,9 +149,14 @@ ERR_error_string, ERR_error_string_n, ERR_lib_error_string, ERR_func_error_strin \& void ERR_error_string_n(unsigned long e, char *buf, size_t len); \& \& const char *ERR_lib_error_string(unsigned long e); -\& const char *ERR_func_error_string(unsigned long e); \& const char *ERR_reason_error_string(unsigned long e); .Ve +.PP +Deprecated in OpenSSL 3.0: +.PP +.Vb 1 +\& const char *ERR_func_error_string(unsigned long e); +.Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBERR_error_string()\fR generates a human-readable string representing the @@ -169,14 +174,13 @@ For \fBERR_error_string_n()\fR, \fIbuf\fR may not be \fB\s-1NULL\s0\fR. The string will have the following format: .PP .Vb 1 -\& error:[error code]:[library name]:[function name]:[reason string] +\& error:[error code]:[library name]::[reason string] .Ve .PP -\&\fIerror code\fR is an 8 digit hexadecimal number, \fIlibrary name\fR, -\&\fIfunction name\fR and \fIreason string\fR are \s-1ASCII\s0 text. +\&\fIerror code\fR is an 8 digit hexadecimal number, \fIlibrary name\fR and +\&\fIreason string\fR are \s-1ASCII\s0 text. .PP -\&\fBERR_lib_error_string()\fR, \fBERR_func_error_string()\fR and -\&\fBERR_reason_error_string()\fR return the library name, function +\&\fBERR_lib_error_string()\fR and \fBERR_reason_error_string()\fR return the library name and reason string respectively. .PP If there is no text string registered for the given error code, @@ -189,18 +193,22 @@ all error codes currently in the queue. \&\fBERR_error_string()\fR returns a pointer to a static buffer containing the string if \fIbuf\fR \fB== \s-1NULL\s0\fR, \fIbuf\fR otherwise. .PP -\&\fBERR_lib_error_string()\fR, \fBERR_func_error_string()\fR and -\&\fBERR_reason_error_string()\fR return the strings, and \fB\s-1NULL\s0\fR if -none is registered for the error code. +\&\fBERR_lib_error_string()\fR and \fBERR_reason_error_string()\fR return the strings, +and \fB\s-1NULL\s0\fR if none is registered for the error code. +.PP +\&\fBERR_func_error_string()\fR returns \s-1NULL.\s0 .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBERR_get_error\fR\|(3), \&\fBERR_print_errors\fR\|(3) +.SH "HISTORY" +.IX Header "HISTORY" +\&\fBERR_func_error_string()\fR became deprecated in OpenSSL 3.0. .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2000\-2017 The OpenSSL Project Authors. All Rights Reserved. .PP -Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use +Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>. |