SASL_GETOPT_T(3SASL)SASL_GETOPT_T(3SASL)NAMEsasl_getopt_t - the SASL get option callback function
SYNOPSIS
cc [ flag ... ] file ... -lsasl [ library ... ]
#include <sasl/sasl.h>
int sasl_getopt_t(void *context, const char *plugin_name,
const char *option, const char **result, unsigned *len);
DESCRIPTION
The sasl_getopt_t() function allows a SASL configuration to be encapsu‐
lated in the caller's configuration system. Some implementations may
use default configuration file(s) if this function is omitted. Configu‐
ration items are arbitrary strings and are plug-in specific.
PARAMETERS
context
The option context from the callback record.
plugin_name
The name of the plug-in. If the value of plugin_name is
NULL, the the plug-in is a general SASL option.
option
The name of the option.
result
The value of result is set and persists until the next
call to sasl_getopt_t() in the same thread. The value of
result is unchanged if option is not found.
len
The length of result. The value of result can be NULL.
RETURN VALUES
Like other SASL callback functions, sasl_getopt_t() returns an integer
that corresponds to a SASL error code. See <sasl.h> for a complete list
of SASL error codes.
ERRORS
SASL_OK
The call to sasl_getopt_t() was successful.
See sasl_errors(3SASL) for information on SASL error codes.
ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
┌────────────────────┬─────────────────┐
│ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
├────────────────────┼─────────────────┤
│Interface Stability │ Evolving │
├────────────────────┼─────────────────┤
│MT-Level │ MT-Safe │
└────────────────────┴─────────────────┘
SEE ALSOsasl_errors(3SASL), attributes(5)
Oct 27, 2003 SASL_GETOPT_T(3SASL)
