---
name: "sasl_getrealm_t"
section: "3"
platform: "linux"
package: "libsasl2-dev"
version: "2.1.28+dfsg1-9"
release: "Debian 13 (Trixie)"
platforms: ["linux", "macos"]
url: "https://new.carta.tech/sasl_getrealm_t"
---

# sasl\_getrealm\_t(3)

Cyrus SASL documentation

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

## SEE ALSO

*RFC 4422*,:saslman:*[sasl(3)](/sasl/3.md)*, *[sasl\_callbacks(3)](/sasl_callbacks/3.md)*

## AUTHOR

The Cyrus Team

## COPYRIGHT

1993-2016, The Cyrus Team