sasl_client_init(3) [debian man page]

sasl_client_init(3)						  SASL man pages					       sasl_client_init(3)

NAME

       sasl_client_init - SASL client authentication initialization

SYNOPSIS

       #include <sasl/sasl.h>

       int sasl_client_init(const  sasl_callback_t *callbacks);

DESCRIPTION

       sasl_client_init() initializes SASL. It must be called before any calls to sasl_client_start. This call initializes all SASL client drivers
       (e.g. authentication mechanisms). These are usually found in the /usr/lib/sasl2 directory but the directory  may  be  overridden  with  the
       SASL_PATH environment variable.

       callbacks specifies the base callbacks for all client connections. See the sasl_callbacks man page for more information

RETURN VALUE

       sasl_client_init  returns  an  integer which corresponds to one of the following codes. SASL_OK is the only one that indicates success. All
       others indicate errors and should either be handled or the authentication session should be quit.

ERRORS

       SASL_OK Success

       SASL_BADVERS
	       Mechanism version mismatch

       SASL_BADPARAM
	       Error in config file

       SASL_NOMEM
	       Not enough memory to complete operation

CONFORMING TO

       RFC 4422

SEE ALSO

       sasl(3), sasl_callbacks(3), sasl_client_new(3), sasl_client_start(3), sasl_client_step(3)

SASL
								   21 June 2001 					       sasl_client_init(3)

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

NAME

       sasl_client_init - initialize SASL client authentication

SYNOPSIS

       cc [ flag ... ] file ... -lsasl	 [ library ... ]
       #include <sasl/sasl.h>

       int sasl_client_init(const sasl_callback_t *callbacks);

DESCRIPTION

       Use  the  sasl_client_init()  interface	to  initialize	SASL.  The  sasl_client_init()	interface  must  be  called  before  any  calls to
       sasl_client_start(3SASL).  The call to sasl_client_init() initiallizes all SASL client drivers,	for  example,  authentication  mechanisms.
       SASL client drivers are usually found in the /usr/lib/sasl directory.

PARAMETERS

       callbacks       Specifies the base callbacks for all client connections.

RETURN VALUES

       sasl_client_init() returns an integer that corresponds to a SASL error code.

ERRORS

       SASL_OK	       The call to sasl_client_init() was successful.

       SASL_BADVERS    There is a mismatch in the mechanism version.

       SASL_BADPARAM   There is an error in the configuration file.

       SASL_NOMEM      There is not enough memory to complete the operation.

       All  other  error  codes  indicate  an  error  situation  that  must  be  handled,  or  the  authentication  session  should  be  quit. 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		     |Unsafe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       sasl_errors(3SASL), attributes(5)

NOTES

       While most of libsasl is MT-Safe, no other libsasl function should be called until this function completes.

SunOS 5.10							    22 Oct 2003 					   sasl_client_init(3SASL)