FreeBSD Manual Pages
SASL_GETOPT_T(3) Cyrus SASL SASL_GETOPT_T(3) NAME sasl_getopt_t - Cyrus SASL documentation SYNOPSIS #include <sasl/sasl.h> int sasl_getopt_t(void *context, const char *plugin_name, const char *option, const char ** result, unsigned * len); DESCRIPTION int sasl_getopt_t(void *context, const char *plugin_name, const char *option, const char ** result, unsigned * len); sasl_getopt_t is used to retrieve an option, often mechanism specific, from the application. An example of this is requesting what KERBEROS_V4 srvtab file to use. Parameters • context is the SASL connection context • plugin_name is the plugin this value is for. • option is a string representing the option. A common option that all server applications should handle is the method for checking plaintext passwords. See the administrators guide for a full description of this op- tion. Memory management of options supplied by the getopt callback should be done by the application, however, any requested option must remain available until the callback is no longer valid. That is, when sasl_dispose(3) is called for a the connection it is associated with, or sasl_done(3) is called for global call- backs. 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_errors(3) sasl_callbacks(3) AUTHOR The Cyrus Team COPYRIGHT 1993-2016, The Cyrus Team 2.1.28 February 18, 2022 SASL_GETOPT_T(3)
NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | SEE ALSO | AUTHOR | COPYRIGHT
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=sasl_getopt_t&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>