xref: /freebsd/crypto/openssl/doc/man3/ERR_load_strings.pod (revision ba3c1f5972d7b90feb6e6da47905ff2757e0fe57)
1=pod
2
3=head1 NAME
4
5ERR_load_strings, ERR_PACK, ERR_get_next_error_library - load
6arbitrary error strings
7
8=head1 SYNOPSIS
9
10 #include <openssl/err.h>
11
12 int ERR_load_strings(int lib, ERR_STRING_DATA *str);
13
14 int ERR_get_next_error_library(void);
15
16 unsigned long ERR_PACK(int lib, int func, int reason);
17
18=head1 DESCRIPTION
19
20ERR_load_strings() registers error strings for library number B<lib>.
21
22B<str> is an array of error string data:
23
24 typedef struct ERR_string_data_st
25 {
26     unsigned long error;
27     char *string;
28 } ERR_STRING_DATA;
29
30The error code is generated from the library number and a function and
31reason code: B<error> = ERR_PACK(B<lib>, B<func>, B<reason>).
32ERR_PACK() is a macro.
33
34The last entry in the array is {0,0}.
35
36ERR_get_next_error_library() can be used to assign library numbers
37to user libraries at run time.
38
39=head1 RETURN VALUES
40
41ERR_load_strings() returns 1 for success and 0 for failure. ERR_PACK() returns the error code.
42ERR_get_next_error_library() returns zero on failure, otherwise a new
43library number.
44
45=head1 SEE ALSO
46
47L<ERR_load_strings(3)>
48
49=head1 COPYRIGHT
50
51Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.
52
53Licensed under the Apache License 2.0 (the "License").  You may not use
54this file except in compliance with the License.  You can obtain a copy
55in the file LICENSE in the source distribution or at
56L<https://www.openssl.org/source/license.html>.
57
58=cut
59