sasl_getopt_t(3) [mojave man page]

sasl_getopt_t(3)						  SASL man pages						  sasl_getopt_t(3)

NAME

       sasl_getopt_t - The SASL get option callback

SYNOPSIS

       #include <sasl/sasl.h>

       int sasl_getopt_t(void *context,
		      const char *plugin_name,
		      const char *option,
		      const char ** result,
		      unsigned * len);

DESCRIPTION

       sasl_getopt_t  is  used	to  retrieve  an option, often mechanism specific, from the application. An example of this is requested what KER-
       BEROS_V4 srvtab file to use.  plugin_name is the plugin this value if for.  option is a string representing the	option.  A  common  option
       that  all server applications should handle is method for checking plaintext passwords. See the administrators guide for a full description
       of this option.

       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 is called for a the connection it is associated with, or
       sasl_done is called for global callbacks.

RETURN VALUE

       SASL callback functions should return SASL return codes. See sasl.h for a complete list. SASL_OK indicates success.

CONFORMING TO

       RFC 4422

SEE ALSO

       sasl(3), sasl_callbacks(3), sasl_errors(3)

SASL
								   10 July 2001 						  sasl_getopt_t(3)

sasl_getopt_t(3SASL)			      Simple Authentication Security Layer Library Functions			      sasl_getopt_t(3SASL)

NAME

       sasl_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 encapsulated in the caller's configuration system. Some implementations may
       use default configuration file(s) if this function is omitted. Configuration 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	   |
       +-----------------------------+-----------------------------+
       |Availability		     |SUNWlibsasl		   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Evolving			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       sasl_errors(3SASL), attributes(5)

SunOS 5.11							    27 Oct 2003 					      sasl_getopt_t(3SASL)