aboutsummaryrefslogtreecommitdiffstats
path: root/liberror_pop_error.3
diff options
context:
space:
mode:
Diffstat (limited to 'liberror_pop_error.3')
-rw-r--r--liberror_pop_error.352
1 files changed, 52 insertions, 0 deletions
diff --git a/liberror_pop_error.3 b/liberror_pop_error.3
new file mode 100644
index 0000000..61bcfbb
--- /dev/null
+++ b/liberror_pop_error.3
@@ -0,0 +1,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)