summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/ERR_load_crypto_strings.3
blob: 7d14b1e572d3a77bb6aa3e4c1009bef5257efe9e (plain)
1
2
3
4
5
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
46
47
48
.Dd $Mdocdate: November 2 2016 $
.Dt ERR_LOAD_CRYPTO_STRINGS 3
.Os
.Sh NAME
.Nm ERR_load_crypto_strings ,
.Nm SSL_load_error_strings ,
.Nm ERR_free_strings
.Nd load and free OpenSSL error strings
.Sh SYNOPSIS
.In openssl/err.h
.Ft void
.Fn ERR_load_crypto_strings void
.Ft void
.Fn ERR_free_strings void
.In openssl/ssl.h
.Ft void
.Fn SSL_load_error_strings void
.Sh DESCRIPTION
.Fn ERR_load_crypto_strings
registers the error strings for all
.Xr crypto 3
functions.
.Fn SSL_load_error_strings
does the same, but also registers the
.Xr ssl 3
error strings.
.Pp
One of these functions should be called before generating textual error
messages.
However, this is not required when memory usage is an issue.
.Pp
.Fn ERR_free_strings
frees all previously loaded error strings.
.Sh RETURN VALUES
.Fn ERR_load_crypto_strings ,
.Fn SSL_load_error_strings ,
and
.Fn ERR_free_strings
return no values.
.Sh SEE ALSO
.Xr ERR 3 ,
.Xr ERR_error_string 3
.Sh HISTORY
.Xr ERR_load_error_strings 3 ,
.Fn SSL_load_error_strings ,
and
.Fn ERR_free_strings
are available in all versions of SSLeay and OpenSSL.