aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man/libcoopgamma_context_unmarshal.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/libcoopgamma_context_unmarshal.3')
-rw-r--r--doc/man/libcoopgamma_context_unmarshal.386
1 files changed, 0 insertions, 86 deletions
diff --git a/doc/man/libcoopgamma_context_unmarshal.3 b/doc/man/libcoopgamma_context_unmarshal.3
deleted file mode 100644
index f805163..0000000
--- a/doc/man/libcoopgamma_context_unmarshal.3
+++ /dev/null
@@ -1,86 +0,0 @@
-.TH LIBCOOPGAMMA_CONTEXT_UNMARSHAL 3 LIBCOOPGAMMA
-.SH "NAME"
-libcoopgamma_context_unmarshal - Unmarshal a libcoopgamma_context_t
-.SH "SYNOPSIS"
-.nf
-#include <libcoopgamma.h>
-
-int libcoopgamma_context_unmarshal(libcoopgamma_context_t *restrict \fIthis\fP,
- void *restrict \fIbuffer\fP, size_t *restrict \fIn\fP);
-.fi
-.P
-Link with
-.IR -lcoopgamma .
-.SH "DESCRIPTION"
-The
-.BR libcoopgamma_context_unmarshal ()
-function unmarshals
-.I this
-from a
-.I buffer .
-The number of read bytes from
-.I buffer
-is stored in
-.I *n
-on success.
-.P
-None if the parameters may be
-.IR NULL .
-.I this
-does not have to be initialised.
-.P
-On failure,
-.I this
-should be deinitialised using
-.BR libcoopgamma_context_destroy (3).
-.P
-Undefined behaviour is invoked if the
-beginning of
-.I buffer
-does not contain data stored by
-.BR libcoopgamma_context_marshal (3).
-.SH "RETURN VALUES"
-The
-.BR libcoopgamma_context_unmarshal ()
-function returns one of the following
-values:
-.TP
-.IR LIBCOOPGAMMA_SUCCESS " (= 0)"
-The function was successful.
-.TP
-.IR LIBCOOPGAMMA_INCOMPATIBLE_DOWNGRADE " (> 0)"
-The data in
-.I buffer
-was stored by an earlier version of
-.BR libcoopgamma (7)
-that is no longer supported.
-.TP
-.IR LIBCOOPGAMMA_INCOMPATIBLE_UPGRADE " (> 0)"
-The data in
-.I buffer
-was stored by a newer version of
-.BR libcoopgamma (7)
-that stores the data in an incompatible format.
-.TP
-.IR LIBCOOPGAMMA_ERRNO_SET "(= -1)"
-An other error was encountered.
-.I errno
-has been set appropriately.
-.SH "ERROR"
-The
-.BR libcoopgamma_context_marshal ()
-function may fail, and returned
-.I LIBCOOPGAMMA_ERRNO_SET
-for any reason specified for
-.BR malloc (3).
-.SH "SEE ALSO"
-.BR libcoopgamma_context_destroy (3),
-.BR libcoopgamma_context_marshal (3),
-.BR libcoopgamma_ramps_unmarshal (3),
-.BR libcoopgamma_filter_unmarshal (3),
-.BR libcoopgamma_crtc_info_unmarshal (3),
-.BR libcoopgamma_filter_query_unmarshal (3),
-.BR libcoopgamma_queried_filter_unmarshal (3),
-.BR libcoopgamma_filter_table_unmarshal (3),
-.BR libcoopgamma_error_unmarshal (3),
-.BR libcoopgamma_async_context_unmarshal (3)