Doc fix.
[gsasl.git] / doc / gsasl-callback-authorization.texi
blobf48cb5a42c743f9f59ececc82efee3038e2a8287
1 @deftypefn Prototype int (*Gsasl_client_callback_authorization_id) (Gsasl_session_ctx * @var{ctx}, char * @var{out}, size_t * @var{outlen})
3 @var{ctx}:  libgsasl handle.
5 @var{out}:  output array with authorization identity.
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 authorization identity of user and set
12 the output array length, and return @code{GSASL_OK}, or fail with an
13 error code. The authorization identity must be encoded in UTF-8, but
14 need not be normalized in any way.
16 If OUT is NULL, the function should only populate the output length
17 field with the length, and return GSASL_OK.  This usage may be used by
18 the caller to allocate the proper buffer size.
20 @end deftypefn