sasl_getrealm_t(3)

sasl_getrealm_t3

Cyrus sasl documentation

Usage

#include <sasl/sasl.h>
int sasl_getrealm_t(void *context,
    int id,
    const char **availrealms,
    const char **result)

Overview

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).

Parameters
•

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)

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.

Releases

11 releases since Debian 3.1 (Sarge); the text changed 5 times.

  1. 3.1
  2. 4.0–9
  3. 10
  4. 11
  5. 12
  6. 13

Author

The Cyrus Team

From libsasl2-dev 2.1.28+dfsg1-9 in Debian 13 (Trixie). Parsed by carta from the page's man source.