1.. saslman:: sasl_client_plug_init_t(3)
2
3.. _sasl-reference-manpages-library-sasl_client_plug_init_t:
4
5========================================================
6**sasl_client_plug_init_t** - client plug‐in entry point
7========================================================
8
9Synopsis
10========
11
12.. code-block:: C
13
14    #include <sasl/saslplug.h>
15
16    int sasl_client_plug_init_t(const sasl_utils_t *utils,
17                                          int max_version,
18                                         int *out_version,
19                            sasl_client_plug_t **pluglist,
20                                           int *plugcount);
21
22Description
23===========
24
25.. c:function::  int sasl_client_plug_init_t(const sasl_utils_t *utils,
26        int max_version,
27        int *out_version,
28        sasl_client_plug_t **pluglist,
29        int *plugcount);
30
31    The **sasl_client_plug_init_t** callback function is the client
32    plugin entry point.
33
34    :param utils: The utility callback functions.
35
36    :param max_version: The highest client plugin version supported.
37
38    :param out_version: The client plugin version of the result.
39
40    :param pluglist: The list of client mechanism plugins.
41
42    :param plugcount: The number of client mechanism plugins.
43
44    :returns: Returns  :c:macro:`SASL_OK` on success. See
45        :saslman:`sasl_errors(3)` for meanings of other return codes.
46
47Return Value
48============
49
50SASL functions should return SASL return codes.
51See sasl.h for a complete list. :c:macro:`SASL_OK` indicates success.
52
53
54Conforming to
55=============
56
57:rfc:`4422`
58
59See Also
60========
61
62:saslman:`sasl(3)`, :saslman:`sasl_errors(3)`
63