diff options
| author | Mattias Andrée <maandree@kth.se> | 2019-04-13 20:41:54 +0200 |
|---|---|---|
| committer | Mattias Andrée <maandree@kth.se> | 2019-04-13 20:41:54 +0200 |
| commit | 57bfbe4a09a898f11da686646164d3fdf3875123 (patch) | |
| tree | f4bf860bbef8ab681f0c0857316af4b7951d7c37 /liberror_print_bactrace.3 | |
| parent | m (diff) | |
| download | liberror-57bfbe4a09a898f11da686646164d3fdf3875123.tar.gz liberror-57bfbe4a09a898f11da686646164d3fdf3875123.tar.bz2 liberror-57bfbe4a09a898f11da686646164d3fdf3875123.tar.xz | |
And man pages for the function, and add print function to user specifiec error details
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'liberror_print_bactrace.3')
| -rw-r--r-- | liberror_print_bactrace.3 | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/liberror_print_bactrace.3 b/liberror_print_bactrace.3 new file mode 100644 index 0000000..9edd680 --- /dev/null +++ b/liberror_print_bactrace.3 @@ -0,0 +1,62 @@ +.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_free_error (3), +.BR liberror_get_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) |