1.. saslman:: sasl_client_init(3)
2
3.. _sasl-reference-manpages-library-sasl_client_init:
4
5
6================================================================
7**sasl_client_init** - SASL client authentication initialization
8================================================================
9
10Synopsis
11========
12
13.. code-block:: C
14
15    #include <sasl/sasl.h>
16
17    int sasl_client_init(const  sasl_callback_t *callbacks )
18
19Description
20===========
21
22**sasl_client_init** initializes SASL.
23
24It  must  be  called  before  any  calls  to
25:saslman:`sasl_client_start(3)`. This call initializes all SASL client  drivers
26(e.g.  authentication mechanisms). These are usually found in the
27`/usr/lib/sasl2` directory but the directory may be overridden with
28the `SASL_PATH` environment variable.
29
30Return Value
31============
32
33SASL  callback  functions should return SASL return codes.
34See sasl.h for a complete list. :c:macro:`SASL_OK` indicates success.
35
36The following return codes indicate errors and should either be handled or the authentication
37session should be quit:
38
39* :c:macro:`SASL_BADVERS`: Mechanism version mismatch
40* :c:macro:`SASL_BADPARAM`: Error in config file
41* :c:macro:`SASL_NOMEM`: Not enough memory to complete operation
42
43See Also
44========
45
46:rfc:`4422`,:saslman:`sasl(3)`, :saslman:`sasl_callbacks(3)`,
47:saslman:`sasl_client_new(3)`, :saslman:`sasl_client_start(3)`,
48:saslman:`sasl_client_step(3)`
49