Man page - sasl_getrealm_t(3)

Packages contas this manual

Package: libsasl2-dev
apt-get install libsasl2-dev

Manuals in package:

Documentations in package:

SASL_GETREALM_T(3)

Cyrus SASL

SASL_GETREALM_T(3)

sasl_getrealm_t - Cyrus SASL documentation

#include <sasl/sasl.h>
int sasl_getrealm_t(void *context,


    int id,


    const char **availrealms,


    const char **result)

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

context – 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)

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.

The Cyrus Team

1993-2016, The Cyrus Team

2025-02-28

2.1.28