$NetBSD: ERR_new.3,v 1.5 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_new 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
ERR_new, ERR_set_debug, ERR_set_error, ERR_vset_error \- Error recording building blocks Header "SYNOPSIS" .Vb 1 #include <openssl/err.h> \& void ERR_new(void); void ERR_set_debug(const char *file, int line, const char *func); void ERR_set_error(int lib, int reason, const char *fmt, ...); void ERR_vset_error(int lib, int reason, const char *fmt, va_list args); .Ve Header "DESCRIPTION" The functions described here are generally not used directly, but rather through macros such as ERR_raise\|(3). They can still be useful for anyone that wants to make their own macros.

\fBERR_new() allocates a new slot in the thread's error queue.

\fBERR_set_debug() sets the debug information related to the current error in the thread's error queue. The values that can be given are the filename file, line in the file line and the name of the function func where the error occurred. The names must be constant, this function will only save away the pointers, not copy the strings.

\fBERR_set_error() sets the error information, which are the library number lib and the reason code reason, and additional data as a format string fmt and an arbitrary number of arguments. The additional data is processed with BIO_snprintf\|(3) to form the additional data string, which is allocated and store in the error record.

\fBERR_vset_error() works like ERR_set_error(), but takes a va_list argument instead of a variable number of arguments.

Header "RETURN VALUES" ERR_new, ERR_set_debug, ERR_set_error and ERR_vset_error do not return any values. Header "NOTES" The library number is unique to each unit that records errors. OpenSSL has a number of preallocated ones for its own uses, but others may allocate their own library number dynamically with \fBERR_get_next_error_library\|(3).

Reason codes are unique within each library, and may have an associated set of strings as a short description of the reason. For dynamically allocated library numbers, reason strings are recorded with ERR_load_strings\|(3).

Provider authors are supplied with core versions of these functions, see provider-base\|(7).

Header "SEE ALSO" \fBERR_raise\|(3), ERR_get_next_error_library\|(3), \fBERR_load_strings\|(3), BIO_snprintf\|(3), provider-base\|(7) Header "COPYRIGHT" Copyright 2000-2020 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>.