sasl_getopt_t(3sasl)

1sasl_getopt_tS(i3mSpAlSeL)Authentication Security Layer Library Fusnacstli_ognestopt_t(3SASL)
2
3
4

NAME

6       sasl_getopt_t - the SASL get option callback function
7

SYNOPSIS

9       cc [ flag ... ] file ... -lsasl   [ library ... ]
10       #include <sasl/sasl.h>
11
12       int sasl_getopt_t(void *context, const char *plugin_name,
13            const char *option, const char **result, unsigned *len);
14
15

DESCRIPTION

17       The sasl_getopt_t() function allows a SASL configuration to be encapsu‐
18       lated in the caller's configuration system.  Some  implementations  may
19       use default configuration file(s) if this function is omitted. Configu‐
20       ration items are arbitrary strings and are plug-in specific.
21

PARAMETERS

23       context        The option context from the callback record.
24
25
26       plugin_name    The name of the plug-in. If the value of plugin_name  is
27                      NULL, the the plug-in is a general SASL option.
28
29
30       option         The name of the option.
31
32
33       result         The  value  of result is set and persists until the next
34                      call to sasl_getopt_t() in the same thread. The value of
35                      result is unchanged if option is not found.
36
37
38       len            The length of result. The value of result can be NULL.
39
40

RETURN VALUES

42       Like  other SASL callback functions, sasl_getopt_t() returns an integer
43       that corresponds to a SASL error code. See <sasl.h> for a complete list
44       of SASL error codes.
45

ERRORS

47       SASL_OK    The call to sasl_getopt_t() was successful.
48
49
50
51       See sasl_errors(3SASL) for information on SASL error codes.
52

ATTRIBUTES

54       See attributes(5) for descriptions of the following attributes:
55
56
57
58
59       ┌─────────────────────────────┬─────────────────────────────┐
60       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
61       ├─────────────────────────────┼─────────────────────────────┤
62       │Availability                 │SUNWlibsasl                  │
63       ├─────────────────────────────┼─────────────────────────────┤
64       │Interface Stability          │Evolving                     │
65       ├─────────────────────────────┼─────────────────────────────┤
66       │MT-Level                     │MT-Safe                      │
67       └─────────────────────────────┴─────────────────────────────┘
68