xref: /illumos-gate/usr/src/man/man3sasl/sasl_canonuser_add_plugin.3sasl (revision 8533946bd264dca901fdf56bf3da1d81e728b423)
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_CANONUSER_ADD_PLUGIN 3SASL "Sep 16, 2003"
NAME
sasl_canonuser_add_plugin - add a SASL user canonicalization plug-in
SYNOPSIS

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

int sasl_canonuser_add_plugin(const char *plugname,
 sasl_canonuser_plug_init_t *cplugfunc);
DESCRIPTION

Use the sasl_canonuser_add_plugin() interface to add a user canonicalization plug-in to the current list of user canonicalization plug-ins in the SASL library.

PARAMETERS
plugname

The name of the user canonicalization plug-in.

cplugfunc

The value of cplugfunc is filled in by the sasl_canonuser_plug_init_t structure.

RETURN VALUES

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

ERRORS
SASL_OK

The call to sasl_client_add_plugin() was successful.

SASL_BADVERS

Version mismatch with plug-in.

SASL_NOMEM

Memory shortage failure.

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

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Evolving
MT-Level MT-Safe
SEE ALSO

sasl_errors(3SASL), attributes(5)