]> git.ipfire.org Git - thirdparty/openssl.git/blame - doc/crypto/ERR_put_error.pod
Remove SSLeay history, etc., from docs
[thirdparty/openssl.git] / doc / crypto / ERR_put_error.pod
CommitLineData
388f2f56
UM
1=pod
2
3=head1 NAME
4
4d524e10 5ERR_put_error, ERR_add_error_data - record an error
388f2f56
UM
6
7=head1 SYNOPSIS
8
9 #include <openssl/err.h>
10
11 void ERR_put_error(int lib, int func, int reason, const char *file,
12 int line);
13
14 void ERR_add_error_data(int num, ...);
15
16=head1 DESCRIPTION
17
18ERR_put_error() adds an error code to the thread's error queue. It
19signals that the error of reason code B<reason> occurred in function
20B<func> of library B<lib>, in line number B<line> of B<file>.
21This function is usually called by a macro.
22
23ERR_add_error_data() associates the concatenation of its B<num> string
24arguments with the error code added last.
25
9b86974e 26L<ERR_load_strings(3)> can be used to register
388f2f56
UM
27error strings so that the application can a generate human-readable
28error messages for the error code.
29
30=head1 RETURN VALUES
31
32ERR_put_error() and ERR_add_error_data() return
33no values.
34
35=head1 SEE ALSO
36
9b86974e 37L<err(3)>, L<ERR_load_strings(3)>
388f2f56 38
388f2f56 39=cut