ERR_load_strings.pod 1.0 KB
Newer Older
U
Ulf Möller 已提交
1 2 3 4
=pod

=head1 NAME

U
Ulf Möller 已提交
5
ERR_load_strings, ERR_PACK, ERR_get_next_error_library - load
U
Ulf Möller 已提交
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
arbitrary error strings

=head1 SYNOPSIS

 #include <openssl/err.h>

 void ERR_load_strings(int lib, ERR_STRING_DATA str[]);

 int ERR_get_next_error_library(void);

 unsigned long ERR_PACK(int lib, int func, int reason);

=head1 DESCRIPTION

ERR_load_strings() registers error strings for library number B<lib>.

B<str> is an array of error string data:

 typedef struct ERR_string_data_st
 {
        unsigned long error;
        char *string;
 } ERR_STRING_DATA;

The error code is generated from the library number and a function and
reason code: B<error> = ERR_PACK(B<lib>, B<func>, B<reason>).
ERR_PACK() is a macro.

The last entry in the array is {0,0}.

ERR_get_next_error_library() can be used to assign library numbers
to user libraries at runtime.

=head1 RETURN VALUE

ERR_load_strings() returns no value. ERR_PACK() return the error code.
ERR_get_next_error_library() returns a new library number.

=head1 SEE ALSO

R
Rich Salz 已提交
46
L<err(3)>, L<ERR_load_strings(3)>
U
Ulf Möller 已提交
47 48

=cut