dwww Home | Manual pages | Find package

SASL_GETREALM_T(3)                Cyrus SASL                SASL_GETREALM_T(3)

NAME
       sasl_getrealm_t - Cyrus SASL documentation

SYNOPSIS
       #include <sasl/sasl.h>

       int sasl_getrealm_t(void *context,
           int id,
           const char **availrealms,
           const char **result)

DESCRIPTION
       int sasl_getrealm_t(void *context,

       int id,

       const char **availrealms,

       const char **result)
              sasl_getrealm_t()  is  used  when  there  is an interaction with
              SASL_CB_GETREALM as the type.

              If a mechanism would use  this   callback,   but   it   is   not
              present,   then   the  first  realm  listed is automatically se-
              lected.  (Note that a  mechanism  may  still  force   the  exis-
              tence   of   a  getrealm callback by SASL_CB_GETREALM to its re-
              quired_prompts list).

              Parameterscontext – context from the callback record

                     • id – callback ID (SASL_CB_GETREALM)

                     • availrealms – A string list of the  available   realms.
                       NULL terminated, may be empty.

                     • result – The chosen realm. (a NUL terminated string)

RETURN VALUE
       SASL   callback  functions should return SASL return codes.  See sasl.h
       for a complete list. SASL_OK indicates success.

       Other return codes indicate errors and should be handled.

SEE ALSO
       RFC 4422,:saslman:sasl(3), sasl_callbacks(3)

AUTHOR
       The Cyrus Team

COPYRIGHT
       1993-2022, The Cyrus Team

2.1.28                            2022-11-22                SASL_GETREALM_T(3)

Generated by dwww version 1.15 on Mon Jun 24 01:44:40 CEST 2024.