diff options
Diffstat (limited to 'libcoopgamma_error_initialise.3')
| -rw-r--r-- | libcoopgamma_error_initialise.3 | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/libcoopgamma_error_initialise.3 b/libcoopgamma_error_initialise.3 new file mode 100644 index 0000000..fba20cf --- /dev/null +++ b/libcoopgamma_error_initialise.3 @@ -0,0 +1,44 @@ +.TH LIBCOOPGAMMA_ERROR_INITIALISE 3 LIBCOOPGAMMA +.SH "NAME" +libcoopgamma_error_initialise - Initialise a libcoopgamma_error_t +.SH "SYNOPSIS" +.nf +#include <libcoopgamma.h> + +int libcoopgamma_error_initialise(libcoopgamma_error_t *restrict \fIthis\fP); +.fi +.P +Link with +.IR -lcoopgamma . +.SH "DESCRIPTION" +The +.BR libcoopgamma_error_initialise () +function initialises +.IR this . +.P +On failure, +.I this +should be deinitialised using +.BR libcoopgamma_error_destroy (3). +.SH "RETURN VALUES" +Upon successful completion, the +.BR libcoopgamma_error_initialise () +function returns 0. On error, -1 is returned and +.I errno +is set appropriately. +.SH "ERRORS" +There are no errors specified for the +.BR libcoopgamma_error_initialise () +function. +.SH "SEE ALSO" +.BR libcoopgamma.h (0), +.BR libcoopgamma_error_destroy (3), +.BR libcoopgamma_error_marshal (3), +.BR libcoopgamma_ramps_initialise (3), +.BR libcoopgamma_filter_initialise (3), +.BR libcoopgamma_crtc_info_initialise (3), +.BR libcoopgamma_filter_query_initialise (3), +.BR libcoopgamma_queried_filter_initialise (3), +.BR libcoopgamma_filter_table_initialise (3), +.BR libcoopgamma_context_initialise (3), +.BR libcoopgamma_async_context_initialise (3) |