components/cyrus-sasl/Solaris/usr/share/man/man3/sasl_server_plug_init_t.3sasl
changeset 5055 9daf220c1a9a
child 5769 6303cfed086b
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/components/cyrus-sasl/Solaris/usr/share/man/man3/sasl_server_plug_init_t.3sasl	Tue Nov 03 14:27:41 2015 -0800
@@ -0,0 +1,120 @@
+'\" te
+.\" Copyright (c) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.
+.\" Portions Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved
+.TH sasl_server_plug_init_t 3SASL "27 Oct 2003" "SunOS 5.12" "Simple Authentication Security Layer Library Functions"
+.SH NAME
+sasl_server_plug_init_t \- server plug-in entry point
+.SH SYNOPSIS
+.LP
+.nf
+\fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
+#include <sasl/saslplug.h>
+
+\fBint\fR \fBsasl_server_plug_init_t\fR(\fBconst sasl_utils_t *\fR\fIutils\fR, \fBint\fR \fImax_version\fR,
+     \fBint *\fR\fIout_version\fR, \fBsasl_client_plug_t **\fR\fIpluglist\fR, \fBint *\fR\fIplugcount\fR);
+.fi
+
+.SH DESCRIPTION
+.sp
+.LP
+The \fBsasl_server_plug_init_t()\fR callback function is the server plug-in entry point.
+.SH PARAMETERS
+.sp
+.ne 2
+.mk
+.na
+\fB\fIutils\fR\fR
+.ad
+.RS 15n
+.rt  
+The utility callback functions.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fImax_version\fR\fR
+.ad
+.RS 15n
+.rt  
+The highest server plug-in version supported.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fIout_version\fR\fR
+.ad
+.RS 15n
+.rt  
+The server plug-in version of the result.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fIpluglist\fR\fR
+.ad
+.RS 15n
+.rt  
+The list of server mechanism plug-ins.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fIplugcount\fR\fR
+.ad
+.RS 15n
+.rt  
+The number of server mechanism plug-ins.
+.RE
+
+.SH RETURN VALUES
+.sp
+.LP
+Like other SASL callback functions, \fBsasl_server_plug_init_t()\fR returns an integer that corresponds to a SASL error code. See <\fBsasl.h\fR> for a complete list of SASL error codes.
+.SH ERRORS
+.sp
+.ne 2
+.mk
+.na
+\fB\fBSASL_OK\fR\fR
+.ad
+.RS 11n
+.rt  
+The call to \fBsasl_server_plug_init_t()\fR was successful.
+.RE
+
+.sp
+.LP
+See \fBsasl_errors\fR(3SASL) for information on SASL error codes.
+.SH ATTRIBUTES
+.sp
+.LP
+See \fBattributes\fR(5) for descriptions of the following attributes:
+.sp
+
+.sp
+.TS
+tab() box;
+cw(2.75i) |cw(2.75i) 
+lw(2.75i) |lw(2.75i) 
+.
+ATTRIBUTE TYPEATTRIBUTE VALUE
+_
+Availabilitysystem/library/security/libsasl
+_
+Interface StabilityCommitted
+_
+MT-LevelMT-Safe
+.TE
+
+.SH SEE ALSO
+.sp
+.LP
+\fBsasl_errors\fR(3SASL), \fBattributes\fR(5)