1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
|
.. saslman:: sasl_getrealm_t(3)
.. _sasl-reference-manpages-library-sasl_getrealm_t:
================================================
**sasl_getrealm_t** - Realm Acquisition Callback
================================================
Synopsis
========
.. code-block:: C
#include <sasl/sasl.h>
int sasl_getrealm_t(void *context,
int id,
const char **availrealms,
const char **result)
Description
===========
.. c:function:: 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).
:param context: context from the callback record
:param id: callback ID (SASL_CB_GETREALM)
:param availrealms: A string list of the available realms. NULL
terminated, may be empty.
:param 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. :c:macro:`SASL_OK` indicates success.
Other return codes indicate errors and should be handled.
See Also
========
:rfc:`4422`,:saslman:`sasl(3)`, :saslman:`sasl_callbacks(3)`
|
