doc/gsasl-callback-authentication.texi

   1 @deftypefn Prototype int (*Gsasl_client_callback_authentication_id) (Gsasl_session_ctx * @var{ctx}, char * @var{out}, size_t * @var{outlen})
   2
   3 @var{ctx}:  libgsasl handle.
   4
   5 @var{out}:  output array with authentication identity.
   6
   7 @var{outlen}:  on input the maximum size of the output array, on output
   8 contains the actual size of the output array.
   9
  10 Type of callback function the application implements.  It should
  11 populate the output array with authentiction identity of user and set
  12 the output array length, and return @code{GSASL_OK}, or fail with an
  13 error code.  The authentication identity must be encoded in UTF-8, but
  14 need not be normalized in any way.
  15
  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.
  19
  20 @end deftypefn