comparison doc/manual/manual_dyncallback_api.tex @ 67:1d68b4778979

minor fix for documentation
author dadler
date Tue, 12 Jan 2016 08:17:50 +0100
parents 3e629dc19168
children b47168dacba6
comparison
equal deleted inserted replaced
66:988f7587e4d4 67:1d68b4778979
64 void dcbFreeCallback(DCCallback* pcb); 64 void dcbFreeCallback(DCCallback* pcb);
65 \end{lstlisting} 65 \end{lstlisting}
66 66
67 \lstinline{dcbNewCallback} creates and initializes a new \emph{Callback} object, 67 \lstinline{dcbNewCallback} creates and initializes a new \emph{Callback} object,
68 where \lstinline{signature} is the needed function signature (format is the 68 where \lstinline{signature} is the needed function signature (format is the
69 one outlined in the language bindings-section of this manual, see \ref{sigchar}) 69 one outlined in the language bindings-section of this manual, see Table \ref{sigchar})
70 of the function to mimic, \lstinline{funcptr} is a pointer to a callback handler, 70 of the function to mimic, \lstinline{funcptr} is a pointer to a callback handler,
71 and \lstinline{userdata} a pointer to custom data that might be useful in the 71 and \lstinline{userdata} a pointer to custom data that might be useful in the
72 handler. 72 handler.
73 Use \lstinline{dcbFreeCallback} to destroy the \emph{Callback} object.\\ 73 Use \lstinline{dcbFreeCallback} to destroy the \emph{Callback} object.\\
74 \\ 74 \\
92 for dynamic iteration over the called-back-function's arguments (input) and 92 for dynamic iteration over the called-back-function's arguments (input) and
93 \capi{result} is a pointer to a \capi{DCValue} object in order to store the 93 \capi{result} is a pointer to a \capi{DCValue} object in order to store the
94 callback's return value (output, to be set by handler).\\ 94 callback's return value (output, to be set by handler).\\
95 Finally, \capi{userdata} is a pointer to some user defined data that can be 95 Finally, \capi{userdata} is a pointer to some user defined data that can be
96 set when creating the callback object. 96 set when creating the callback object.
97 The handler itself returns a signature character (see \ref{sigchar}) specifying the 97 The handler itself returns a signature character (see Table \ref{sigchar}) specifying the
98 data type used for \capi{result}. 98 data type used for \capi{result}.
99 99