blob: 703b74d71385fd099cfc57136555114991535f43 (
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
49
50
51
52
53
54
55
56
57
58
|
.Dd $Mdocdate: November 2 2016 $
.Dt ERR_PUT_ERROR 3
.Os
.Sh NAME
.Nm ERR_put_error ,
.Nm ERR_add_error_data
.Nd record an OpenSSL error
.Sh SYNOPSIS
.In openssl/err.h
.Ft void
.Fo ERR_put_error
.Fa "int lib"
.Fa "int func"
.Fa "int reason"
.Fa "const char *file"
.Fa "int line"
.Fc
.Ft void
.Fo ERR_add_error_data
.Fa "int num"
.Fa ...
.Fc
.Sh DESCRIPTION
.Fn ERR_put_error
adds an error code to the thread's error queue.
It signals that the error of reason code
.Fa reason
occurred in function
.Fa func
of library
.Fa lib ,
in line number
.Fa line
of
.Fa file .
This function is usually called by a macro.
.Pp
.Fn ERR_add_error_data
associates the concatenation of its
.Fa num
string arguments with the error code added last.
.Pp
.Xr ERR_load_strings 3
can be used to register error strings so that the application can a
generate human-readable error messages for the error code.
.Sh RETURN VALUES
.Fn ERR_put_error
and
.Fn ERR_add_error_data
return no values.
.Sh SEE ALSO
.Xr ERR 3 ,
.Xr ERR_load_strings 3
.Sh HISTORY
.Fn ERR_put_error
is available in all versions of SSLeay and OpenSSL.
.Fn ERR_add_error_data
was added in SSLeay 0.9.0.
|