Remove SSLeay history, etc., from docs
[openssl.git] / doc / crypto / ERR_load_strings.pod
1 =pod
2
3 =head1 NAME
4
5 ERR_load_strings, ERR_PACK, ERR_get_next_error_library - load
6 arbitrary error strings
7
8 =head1 SYNOPSIS
9
10  #include <openssl/err.h>
11
12  void 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
20 ERR_load_strings() registers error strings for library number B<lib>.
21
22 B<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
30 The error code is generated from the library number and a function and
31 reason code: B<error> = ERR_PACK(B<lib>, B<func>, B<reason>).
32 ERR_PACK() is a macro.
33
34 The last entry in the array is {0,0}.
35
36 ERR_get_next_error_library() can be used to assign library numbers
37 to user libraries at runtime.
38
39 =head1 RETURN VALUE
40
41 ERR_load_strings() returns no value. ERR_PACK() return the error code.
42 ERR_get_next_error_library() returns a new library number.
43
44 =head1 SEE ALSO
45
46 L<err(3)>, L<ERR_load_strings(3)>
47
48 =cut