manpagez: man pages & more
man sasl_getrealm_t(3)
Home | html | info | man
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


       sasl_getrealm_t(3) *context,

       int id,

       const char **availrealms,

       const char **result)
              sasl_getrealm_t(3) 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
              selected.  (Note that a  mechanism  may  still  force  the
              existence  of  a  getrealm callback by SASL_CB_GETREALM to its
              required_prompts list).

              Parameters

                     o context - context from the callback record

                     o id - callback ID (SASL_CB_GETREALM)

                     o availrealms - A string list of the available  realms.
                       NULL terminated, may be empty.

                     o 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 sasl(3), sasl_callbacks(3)


AUTHOR

       The Cyrus Team


COPYRIGHT

       1993-2016, The Cyrus Team



2.1.28                          February 18, 2022             sasl_getrealm_t(3)

cyrus-sasl2 2.1.28 - Generated Sun Sep 25 09:35:56 CDT 2022
© manpagez.com 2000-2024
Individual documents may contain additional copyright information.