diff options
Diffstat (limited to 'src/lib/libcrypto/doc/ERR_load_crypto_strings.pod')
| -rw-r--r-- | src/lib/libcrypto/doc/ERR_load_crypto_strings.pod | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/src/lib/libcrypto/doc/ERR_load_crypto_strings.pod b/src/lib/libcrypto/doc/ERR_load_crypto_strings.pod new file mode 100644 index 0000000000..9bdec75a46 --- /dev/null +++ b/src/lib/libcrypto/doc/ERR_load_crypto_strings.pod | |||
| @@ -0,0 +1,46 @@ | |||
| 1 | =pod | ||
| 2 | |||
| 3 | =head1 NAME | ||
| 4 | |||
| 5 | ERR_load_crypto_strings, SSL_load_error_strings, ERR_free_strings - | ||
| 6 | load and free error strings | ||
| 7 | |||
| 8 | =head1 SYNOPSIS | ||
| 9 | |||
| 10 | #include <openssl/err.h> | ||
| 11 | |||
| 12 | void ERR_load_crypto_strings(void); | ||
| 13 | void ERR_free_strings(void); | ||
| 14 | |||
| 15 | #include <openssl/ssl.h> | ||
| 16 | |||
| 17 | void SSL_load_error_strings(void); | ||
| 18 | |||
| 19 | =head1 DESCRIPTION | ||
| 20 | |||
| 21 | ERR_load_crypto_strings() registers the error strings for all | ||
| 22 | B<libcrypto> functions. SSL_load_error_strings() does the same, | ||
| 23 | but also registers the B<libssl> error strings. | ||
| 24 | |||
| 25 | One of these functions should be called before generating | ||
| 26 | textual error messages. However, this is not required when memory | ||
| 27 | usage is an issue. | ||
| 28 | |||
| 29 | ERR_free_strings() frees all previously loaded error strings. | ||
| 30 | |||
| 31 | =head1 RETURN VALUES | ||
| 32 | |||
| 33 | ERR_load_crypto_strings(), SSL_load_error_strings() and | ||
| 34 | ERR_free_strings() return no values. | ||
| 35 | |||
| 36 | =head1 SEE ALSO | ||
| 37 | |||
| 38 | L<err(3)|err(3)>, L<ERR_error_string(3)|ERR_error_string(3)> | ||
| 39 | |||
| 40 | =head1 HISTORY | ||
| 41 | |||
| 42 | ERR_load_error_strings(), SSL_load_error_strings() and | ||
| 43 | ERR_free_strings() are available in all versions of SSLeay and | ||
| 44 | OpenSSL. | ||
| 45 | |||
| 46 | =cut | ||
