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 /libcoopgamma_ramps_initialise.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 'libcoopgamma_ramps_initialise.3')
| -rw-r--r-- | libcoopgamma_ramps_initialise.3 | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/libcoopgamma_ramps_initialise.3 b/libcoopgamma_ramps_initialise.3 new file mode 100644 index 0000000..f6ee3d2 --- /dev/null +++ b/libcoopgamma_ramps_initialise.3 @@ -0,0 +1,62 @@ +.TH LIBCOOPGAMMA_RAMPS_INITIALISE 3 LIBCOOPGAMMA +.SH "NAME" +libcoopgamma_ramps_initialise - Initialise a member type of libcoopgamma_ramps_t +.SH "SYNOPSIS" +.nf +#include <libcoopgamma.h> + +int libcoopgamma_ramps_initialise(void *restrict \fIthis\fP); +.fi +.P +Link with +.IR -lcoopgamma . +.SH "DESCRIPTION" +The +.BR libcoopgamma_ramps_initialise () +function initialises +.IR this . +.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 +The +.BR libcoopgamma_ramps_initialise () +function is defined as a macro. +.P +On failure, +.I this +should be deinitialised using +.BR libcoopgamma_ramps_destroy (3). +.SH "RETURN VALUES" +Upon successful completion, the +.BR libcoopgamma_ramps_initialise () +function returns 0. On error, -1 is returned and +.I errno +is set appropriately. +.SH "ERRORS" +The +.BR libcoopgamma_ramps_initialise () +function may fail for any reason specified for +.BR malloc (3). +.SH "SEE ALSO" +.BR libcoopgamma.h (0), +.BR libcoopgamma_ramps_destroy (3), +.BR libcoopgamma_ramps_marshal (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_error_initialise (3), +.BR libcoopgamma_context_initialise (3), +.BR libcoopgamma_async_context_initialise (3) |