aboutsummaryrefslogtreecommitdiffstats
path: root/liberror_start.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2019-04-13 22:00:04 +0200
committerMattias Andrée <maandree@kth.se>2019-04-13 22:00:04 +0200
commit05ad06600b712a29bc99a65ae89f38d4d8f30371 (patch)
tree1d7d8a6ac3b83c0150635a2e81dd51d4e648e4b3 /liberror_start.3
parentDocument fields for error details (diff)
downloadliberror-05ad06600b712a29bc99a65ae89f38d4d8f30371.tar.gz
liberror-05ad06600b712a29bc99a65ae89f38d4d8f30371.tar.bz2
liberror-05ad06600b712a29bc99a65ae89f38d4d8f30371.tar.xz
Add liberror_start and liberror_end
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'liberror_start.3')
-rw-r--r--liberror_start.353
1 files changed, 53 insertions, 0 deletions
diff --git a/liberror_start.3 b/liberror_start.3
new file mode 100644
index 0000000..1c9b33e
--- /dev/null
+++ b/liberror_start.3
@@ -0,0 +1,53 @@
+.TH LIBERROR_START 3 2019-04-13 liberror
+.SH NAME
+liberror_start \- save and reset the thread's error state
+.SH SYNOPSIS
+.nf
+#include <liberror.h>
+
+void liberror_start(struct liberror_state *\fIstate\fP);
+.fi
+.PP
+Link with
+.IR \-lerror .
+.SH DESCRIPTION
+The
+.BR liberror_start ()
+function saves the thread-local
+.B liberror
+variables to
+.I state
+as well as the value of
+.IR errno ,
+and resets these variables.
+.PP
+Asynchronously called functions such as single
+handlers shall call this function the first thing
+they do.
+.SH RETURN VALUE
+None.
+.SH ERRORS
+None.
+.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_bactrace (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)