$NetBSD: ERR_error_string.3,v 1.25 2024/09/08 13:08:20 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..

..

.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "ERR_error_string 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
ERR_error_string, ERR_error_string_n, ERR_lib_error_string, ERR_func_error_string, ERR_reason_error_string - obtain human-readable error message Header "SYNOPSIS" .Vb 1 #include <openssl/err.h> \& char *ERR_error_string(unsigned long e, char *buf); 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_reason_error_string(unsigned long e); .Ve

Deprecated in OpenSSL 3.0:

.Vb 1 const char *ERR_func_error_string(unsigned long e); .Ve

Header "DESCRIPTION" \fBERR_error_string() generates a human-readable string representing the error code e, and places it at buf. buf must be at least 256 bytes long. If buf is NULL, the error string is placed in a static buffer. Note that this function is not thread-safe and does no checks on the size of the buffer; use ERR_error_string_n() instead.

\fBERR_error_string_n() is a variant of ERR_error_string() that writes at most len characters (including the terminating 0) and truncates the string if necessary. For ERR_error_string_n(), buf may not be NULL.

The string will have the following format:

.Vb 1 error:[error code]:[library name]::[reason string] .Ve

\fIerror code is an 8 digit hexadecimal number, library name and \fIreason string are ASCII text.

\fBERR_lib_error_string() and ERR_reason_error_string() return the library name and reason string respectively.

If there is no text string registered for the given error code, the error string will contain the numeric code.

\fBERR_print_errors\|(3) can be used to print all error codes currently in the queue.

Header "RETURN VALUES" \fBERR_error_string() returns a pointer to a static buffer containing the string if buf == NULL, buf otherwise.

\fBERR_lib_error_string() and ERR_reason_error_string() return the strings, and NULL if none is registered for the error code.

\fBERR_func_error_string() returns NULL.

Header "SEE ALSO" \fBERR_get_error\|(3), \fBERR_print_errors\|(3) Header "HISTORY" \fBERR_func_error_string() became deprecated in OpenSSL 3.0. Header "COPYRIGHT" Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.