From bf4020471356938b9181a33984f511ffdd7ff25b Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Tue, 22 Oct 2019 18:59:27 +0200 Subject: Change license, change style, clean up, flat file hier, clean valgrind output in test MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- libcoopgamma_ramps_unmarshal.3 | 100 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 100 insertions(+) create mode 100644 libcoopgamma_ramps_unmarshal.3 (limited to 'libcoopgamma_ramps_unmarshal.3') diff --git a/libcoopgamma_ramps_unmarshal.3 b/libcoopgamma_ramps_unmarshal.3 new file mode 100644 index 0000000..34393cf --- /dev/null +++ b/libcoopgamma_ramps_unmarshal.3 @@ -0,0 +1,100 @@ +.TH LIBCOOPGAMMA_RAMPS_UNMARSHAL 3 LIBCOOPGAMMA +.SH "NAME" +libcoopgamma_ramps_unmarshal - Unmarshal a member type of libcoopgamma_ramps_t +.SH "SYNOPSIS" +.nf +#include + +int libcoopgamma_ramps_unmarshal(void *restrict \fIthis\fP, void *restrict \fIbuffer\fP, + size_t *restrict \fIn\fP); +.fi +.P +Link with +.IR -lcoopgamma . +.SH "DESCRIPTION" +The +.BR libcoopgamma_ramps_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 +.I this +must be of any of the following types, and not casted +to any other type such as +.I void* +or +.IR libcoopgamma_ramps_t: +.IR libcoopgamma_ramps8_t , +.IR libcoopgamma_ramps16_t , +.IR libcoopgamma_ramps32_t , +.IR libcoopgamma_ramps64_t , +.IR libcoopgamma_rampsf_t , +or +.IR libcoopgamma_rampsd_t . +.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_ramps_destroy (3). +.P +Undefined behaviour is invoked if the +beginning of +.I buffer +does not contain data stored by +.BR libcoopgamma_ramps_marshal (3). +.SH "RETURN VALUES" +The +.BR libcoopgamma_ramps_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_ramps_marshal () +function may fail, and returned +.I LIBCOOPGAMMA_ERRNO_SET +for any reason specified for +.BR malloc (3). +.SH "SEE ALSO" +.BR libcoopgamma_ramps_destroy (3), +.BR libcoopgamma_ramps_marshal (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_context_unmarshal (3), +.BR libcoopgamma_async_context_unmarshal (3) -- cgit v1.2.3-70-g09d2