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_copy_error.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 '')
-rw-r--r-- | liberror_copy_error.3 | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/liberror_copy_error.3 b/liberror_copy_error.3 new file mode 100644 index 0000000..e9bc67e --- /dev/null +++ b/liberror_copy_error.3 @@ -0,0 +1,56 @@ +.TH LIBERROR_COPY_ERROR 3 2019-04-13 liberror +.SH NAME +liberror_copy_error \- create a copy of an error +.SH SYNOPSIS +.nf +#include <liberror.h> + +struct liberror_error *liberror_copy_error(struct liberror_error *\fIerror\fP); +.fi +.PP +Link with +.IR \-lerror . +.SH DESCRIPTION +The +.BR liberror_copy_error () +function creates a copy of if the error specified in the +.I error +parameter. +.PP +The returned error shall be deallocated with the +.BR liberror_free_error (3) +function. +.SH RETURN VALUE +The +.BR liberror_copy_error () +returns a copy of +.I error +upon successful completion, or +.I NULL +on failure, without changing +.IR errno . +.SH ERRORS +This function can only fail of enough memory cannot be +allocated, however the function never change +.IR errno . +.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_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) |