aboutsummaryrefslogtreecommitdiffstats
path: root/liberror_pop_error.3
blob: 61bcfbbf7fea0a2c932e28681a127dd91ebe491a (plain) (blame)
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
.TH LIBERROR_POP_ERROR 3 2020-06-09 liberror
.SH NAME
liberror_pop_error \- replaces the current error with its cause
.SH SYNOPSIS
.nf
#include <liberror.h>

void liberror_pop_error(void);
.fi
.PP
Link with
.IR \-lerror .
.SH DESCRIPTION
The
.BR liberror_pop_error ()
function assigns the causal error for the
current error set for the calling thread
to the thread. If the thread does not have
an error set, nothing will happen. If the
thread's error does not have a cause, it
will be reset without a replacement.
.SH RETURN VALUE
None.
.SH ERRORS
Failure to pop the error is impossible.
.I errno
will not be changed.
.SH EXAMPLES
None.
.SH APPLICATION USAGE
None.
.SH RATIONALE
None.
.SH FUTURE DIRECTIONS
None.
.SH NOTES
None.
.SH SEE ALSO
.BR liberror (7),
.BR liberror.h (0),
.BR liberror_copy_error (3),
.BR liberror_end (3),
.BR liberror_free_error (3),
.BR liberror_get_error (3),
.BR liberror_print_backtrace (3),
.BR liberror_print_error (3),
.BR liberror_reset_error (3),
.BR liberror_save_backtrace (3),
.BR liberror_set_error (3),
.BR liberror_set_error_errno (3),
.BR liberror_set_error_existing (3),
.BR liberror_start (3)