xref: /illumos-gate/usr/src/man/man3sasl/sasl_client_plug_init_t.3sasl (revision e82490700e19f1b8a2cef6102f4726144d281988)
te
Copyright (C) 1998-2003, Carnegie Mellon Univeristy. All Rights Reserved.
Portions Copyright (C) 2003, Sun Microsystems,
Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
SASL_CLIENT_PLUG_INIT_T 3SASL "May 21, 2022"
NAME
sasl_client_plug_init_t - client plug-in entry point
SYNOPSIS
cc [ flag ... ] file ... -lsasl [ library ... ]
#include <sasl/saslplug.h>

int sasl_client_plug_init_t(const sasl_utils_t *utils, int max_version,
 int *out_version, sasl_client_plug_t **pluglist, int *plugcount);
DESCRIPTION
The sasl_client_plug_init_t() callback function is the client plug-in entry point.
PARAMETERS
utils

The utility callback functions.

max_version

The highest client plug-in version supported.

out_version

The client plug-in version of the result.

pluglist

The list of client mechanism plug-ins.

plugcount

The number of client mechanism plug-ins.

RETURN VALUES
Like other SASL callback functions, sasl_client_plug_init_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_client_plug_init_t() was successful.

See sasl_errors(3SASL) for information on SASL error codes.

ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Evolving
MT-Level MT-Safe
SEE ALSO
sasl_errors (3SASL), attributes (7)