Debian Codegraph @

upstream/debian-unstable/man3/ERR_new.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "ERR_NEW 3SSL"
58 .TH ERR_NEW 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 ERR_new, ERR_set_debug, ERR_set_error, ERR_vset_error
65 \&\- Error recording building blocks
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/err.h>
70 \&
71 \& void ERR_new(void);
72 \& void ERR_set_debug(const char *file, int line, const char *func);
73 \& void ERR_set_error(int lib, int reason, const char *fmt, ...);
74 \& void ERR_vset_error(int lib, int reason, const char *fmt, va_list args);
75 .Ve
76 .SH DESCRIPTION
77 .IX Header "DESCRIPTION"
78 The functions described here are generally not used directly, but
79 rather through macros such as \fBERR_raise\fR\|(3).
80 They can still be useful for anyone that wants to make their own
81 macros.
82 .PP
83 \&\fBERR_new()\fR allocates a new slot in the thread's error queue.
84 .PP
85 \&\fBERR_set_debug()\fR sets the debug information related to the current
86 error in the thread's error queue.
87 The values that can be given are the filename \fIfile\fR, line in the
88 file \fIline\fR and the name of the function \fIfunc\fR where the error
89 occurred.
90 The names must be constant, this function will only save away the
91 pointers, not copy the strings.
92 .PP
93 \&\fBERR_set_error()\fR sets the error information, which are the library
94 number \fIlib\fR and the reason code \fIreason\fR, and additional data as a
95 format string \fIfmt\fR and an arbitrary number of arguments.
96 The additional data is processed with \fBBIO_snprintf\fR\|(3) to form the
97 additional data string, which is allocated and store in the error
98 record.
99 .PP
100 \&\fBERR_vset_error()\fR works like \fBERR_set_error()\fR, but takes a \fBva_list\fR
101 argument instead of a variable number of arguments.
102 .SH "RETURN VALUES"
103 .IX Header "RETURN VALUES"
104 ERR_new, ERR_set_debug, ERR_set_error and ERR_vset_error
105 do not return any values.
106 .SH NOTES
107 .IX Header "NOTES"
108 The library number is unique to each unit that records errors.
109 OpenSSL has a number of preallocated ones for its own uses, but
110 others may allocate their own library number dynamically with
111 \&\fBERR_get_next_error_library\fR\|(3).
112 .PP
113 Reason codes are unique within each library, and may have an
114 associated set of strings as a short description of the reason.
115 For dynamically allocated library numbers, reason strings are recorded
116 with \fBERR_load_strings\fR\|(3).
117 .PP
118 Provider authors are supplied with core versions of these functions,
119 see \fBprovider\-base\fR\|(7).
120 .SH "SEE ALSO"
121 .IX Header "SEE ALSO"
122 \&\fBERR_raise\fR\|(3), \fBERR_get_next_error_library\fR\|(3),
123 \&\fBERR_load_strings\fR\|(3), \fBBIO_snprintf\fR\|(3), \fBprovider\-base\fR\|(7)
124 .SH COPYRIGHT
125 .IX Header "COPYRIGHT"
126 Copyright 2000\-2020 The OpenSSL Project Authors. All Rights Reserved.
127 .PP
128 Licensed under the Apache License 2.0 (the "License"). You may not use
129 this file except in compliance with the License. You can obtain a copy
130 in the file LICENSE in the source distribution or at
131 <https://www.openssl.org/source/license.html>.