aboutsummaryrefslogtreecommitdiffstats
path: root/liberror_print_backtrace.3
blob: 72a90d7b2344ee55d8cca06abe6287ed42b7340d (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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
.TH LIBERROR_PRINT_BACKTRACE 3 2019-04-13 liberror
.SH NAME
liberror_print_backtrace \- print the backtrace of an error
.SH SYNOPSIS
.nf
#include <liberror.h>

void liberror_print_backtrace(struct liberror_error *\fIerror\fP, FILE *\fIfp\fP, const char *\fIindent\fP);
.fi
.PP
Link with
.IR \-lerror .
.SH DESCRIPTION
The
.BR liberror_print_backtrace ()
function prints the backtrace of the error
specified in the
.I error
parameter. If no backtrace have been assigned,
for example if the backtace record could not be
allocated, the function will return without
side-effects.
.PP
The
.BR liberror_print_error (3)
function calls the
.BR liberror_print_backtrace ()
function, so there is no need to call the
.BR liberror_print_backtrace ()
function unless you are doing a custom error print.
.PP
.B liberror
only implements a no-operation function, the actual
implementation is implemented in the
.BR liberror-backtrace (7)
library.
.SH RETURN VALUE
None.
.SH ERRORS
.I errno
will never 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_pop_error (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)