Doc fix.
[gsasl.git] / doc / gsasl-callback-passcode.texi
blob3f94c1dee2aa0de9abb390d78c99f5750c210e8f
1 @deftypefn Prototype int (*Gsasl_client_callback_passcode) (Gsasl_session_ctx * @var{ctx}, char * @var{out}, size_t * @var{outlen})
3 @var{ctx}:  libgsasl handle.
5 @var{out}:  output array with passcode.
7 @var{outlen}:  on input the maximum size of the output array, on output
8 contains the actual size of the output array.
10 Type of callback function the application implements.  It should
11 populate the output array with passcode of user and set the output
12 array length, and return @code{GSASL_OK}, or fail with an error code.
14 If OUT is NULL, the function should only populate the output length
15 field with the length, and return GSASL_OK.  This usage may be used by
16 the caller to allocate the proper buffer size.
18 @end deftypefn