Debian Codegraph @

upstream/debian-unstable/man3/ERR_load_strings.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_LOAD_STRINGS 3SSL"
58 .TH ERR_LOAD_STRINGS 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_load_strings, ERR_PACK, ERR_get_next_error_library \- load
65 arbitrary error strings
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/err.h>
70 \&
71 \& int ERR_load_strings(int lib, ERR_STRING_DATA *str);
72 \&
73 \& int ERR_get_next_error_library(void);
74 \&
75 \& unsigned long ERR_PACK(int lib, int func, int reason);
76 .Ve
77 .SH DESCRIPTION
78 .IX Header "DESCRIPTION"
79 \&\fBERR_load_strings()\fR registers error strings for library number \fBlib\fR.
80 .PP
81 \&\fBstr\fR is an array of error string data:
82 .PP
83 .Vb 5
84 \& typedef struct ERR_string_data_st
85 \& {
86 \& unsigned long error;
87 \& char *string;
88 \& } ERR_STRING_DATA;
89 .Ve
90 .PP
91 The error code is generated from the library number and a function and
92 reason code: \fBerror\fR = ERR_PACK(\fBlib\fR, \fBfunc\fR, \fBreason\fR).
93 \&\fBERR_PACK()\fR is a macro.
94 .PP
95 The last entry in the array is {0,0}.
96 .PP
97 \&\fBERR_get_next_error_library()\fR can be used to assign library numbers
98 to user libraries at run time.
99 .SH "RETURN VALUES"
100 .IX Header "RETURN VALUES"
101 \&\fBERR_load_strings()\fR returns 1 for success and 0 for failure. \fBERR_PACK()\fR returns the error code.
102 \&\fBERR_get_next_error_library()\fR returns zero on failure, otherwise a new
103 library number.
104 .SH "SEE ALSO"
105 .IX Header "SEE ALSO"
106 \&\fBERR_load_strings\fR\|(3)
107 .SH COPYRIGHT
108 .IX Header "COPYRIGHT"
109 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
110 .PP
111 Licensed under the Apache License 2.0 (the "License"). You may not use
112 this file except in compliance with the License. You can obtain a copy
113 in the file LICENSE in the source distribution or at
114 <https://www.openssl.org/source/license.html>.