diff options
author | Mattias Andrée <maandree@kth.se> | 2019-10-22 18:59:27 +0200 |
---|---|---|
committer | Mattias Andrée <maandree@kth.se> | 2019-10-22 18:59:27 +0200 |
commit | bf4020471356938b9181a33984f511ffdd7ff25b (patch) | |
tree | 7f9a9abd1ae51318cd435f0ed7471be5f33b478c /doc/man/libcoopgamma_async_context_unmarshal.3 | |
parent | List radharc's priority (diff) | |
download | libcoopgamma-bf4020471356938b9181a33984f511ffdd7ff25b.tar.gz libcoopgamma-bf4020471356938b9181a33984f511ffdd7ff25b.tar.bz2 libcoopgamma-bf4020471356938b9181a33984f511ffdd7ff25b.tar.xz |
Change license, change style, clean up, flat file hier, clean valgrind output in test
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'doc/man/libcoopgamma_async_context_unmarshal.3')
-rw-r--r-- | doc/man/libcoopgamma_async_context_unmarshal.3 | 83 |
1 files changed, 0 insertions, 83 deletions
diff --git a/doc/man/libcoopgamma_async_context_unmarshal.3 b/doc/man/libcoopgamma_async_context_unmarshal.3 deleted file mode 100644 index 5930980..0000000 --- a/doc/man/libcoopgamma_async_context_unmarshal.3 +++ /dev/null @@ -1,83 +0,0 @@ -.TH LIBCOOPGAMMA_ASYNC_CONTEXT_UNMARSHAL 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_async_context_unmarshal - Unmarshal a libcoopgamma_async_context_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_async_context_unmarshal(libcoopgamma_async_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_async_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_async_context_destroy (3). -.P -Undefined behaviour is invoked if the -beginning of -.I buffer -does not contain data stored by -.BR libcoopgamma_async_context_marshal (3). -.SH "RETURN VALUES" -The -.BR libcoopgamma_async_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" -No error is specified for the -.BR libcoopgamma_async_context_marshal () -function. -.SH "SEE ALSO" -.BR libcoopgamma_async_context_destroy (3), -.BR libcoopgamma_async_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_context_unmarshal (3) |