1SASL_GETREALM_T(3)                Cyrus SASL                SASL_GETREALM_T(3)
2
3
4

NAME

6       sasl_getrealm_t - Cyrus SASL documentation
7

SYNOPSIS

9       #include <sasl/sasl.h>
10
11       int sasl_getrealm_t(void *context,
12           int id,
13           const char **availrealms,
14           const char **result)
15

DESCRIPTION

17       int sasl_getrealm_t(void *context,
18
19       int id,
20
21       const char **availrealms,
22
23       const char **result)
24              sasl_getrealm_t()  is  used  when  there  is an interaction with
25              SASL_CB_GETREALM as the type.
26
27              If a mechanism would use  this   callback,   but   it   is   not
28              present,   then   the   first   realm   listed  is automatically
29              selected.  (Note that a  mechanism  may  still  force  the exis‐
30              tence   of   a   getrealm  callback  by  SASL_CB_GETREALM to its
31              required_prompts list).
32
33              Parameters
34
35                     · context – context from the callback record
36
37                     · id – callback ID (SASL_CB_GETREALM)
38
39                     · availrealms – A string list of the  available   realms.
40                       NULL terminated, may be empty.
41
42                     · result – The chosen realm. (a NUL terminated string)
43

RETURN VALUE

45       SASL   callback  functions should return SASL return codes.  See sasl.h
46       for a complete list. SASL_OK indicates success.
47
48       Other return codes indicate errors and should be handled.
49

SEE ALSO

51       RFC 4422,:saslman:sasl(3), sasl_callbacks(3)
52

AUTHOR

54       The Cyrus Team
55

57       1993-2016, The Cyrus Team
58
59
60
61
622.1.27                         November 08, 2018            SASL_GETREALM_T(3)
Impressum