components/cyrus-sasl/Solaris/usr/share/man/man3/sasl_client_add_plugin.3
author Rich Burridge <rich.burridge@oracle.com>
Tue, 02 May 2017 17:33:26 -0700
changeset 7964 d9801318ed3d
parent 6316 351665422d31
permissions -rw-r--r--
25981468 Build ilmbase and openexr with the GNU compilers

'\" te
.\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.
.\" Portions Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved
.TH sasl_client_add_plugin 3sasl "12 Sep 2003" SASL "SASL man pages"
.SH NAME
sasl_client_add_plugin \- add a SASL client plug-in

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

.BI " int sasl_client_add_plugin(const char *" plugname ", "
.BI "				 sasl_client_plug_init_t *" cplugfunc "); "
.fi

.SH DESCRIPTION
Use the 
.B sasl_client_add_plugin()
interface to add a client plug-in to the current in-memory list of client plug-ins in the SASL library.

.SH PARAMETERS
.I plugname
The name of the client plug-in.

.I cplugfunc
The value of cplugfunc is filled in by the sasl_client_plug_init_t structure.

.SH "RETURN VALUES"
sasl_client_add_plugin() returns an integer that corresponds to a SASL error code.

.SH ERRORS
.TP 0.8i
.B SASL_OK
The call to sasl_client_add_plugin() was successful.
.TP 0.8i
.B SASL_BADVERS
Version mismatch with plug-in.
.TP 0.8i
.B SASL_NOMEM
Memory shortage failure.

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

.SH "SEE ALSO"
sasl_errors(3SASL)