upstream/oracle/userland-gate: components/cyrus-sasl/Solaris/usr/share/man/man3/sasl_client_plug_init

5055 9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	1	'\" te
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	2	.\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy. All Rights Reserved.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	3	.\" Portions Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	4	.TH sasl_client_plug_init_t 3SASL "27 Oct 2003" "SunOS 5.12" "Simple Authentication Security Layer Library Functions"
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	5	.SH NAME
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	6	sasl_client_plug_init_t \- client plug-in entry point
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	7	.SH SYNOPSIS
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	8	.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	9	.nf
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	10	\fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR [ \fIlibrary\fR ... ]
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	11	#include <sasl/saslplug.h>
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	12
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	13	\fBint\fR \fBsasl_client_plug_init_t\fR(\fBconst sasl_utils_t *\fR\fIutils\fR, \fBint\fR \fImax_version\fR,
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	14	\fBint \fR\fIout_version\fR, \fBsasl_client_plug_t \fR\fIpluglist\fR, \fBint \fR\fIplugcount\fR);
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	15	.fi
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	16
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	17	.SH DESCRIPTION
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	18	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	19	.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	20	The \fBsasl_client_plug_init_t()\fR callback function is the client plug-in entry point.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	21	.SH PARAMETERS
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	22	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	23	.ne 2
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	24	.mk
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	25	.na
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	26	\fB\fIutils\fR\fR
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	27	.ad
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	28	.RS 15n
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	29	.rt
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	30	The utility callback functions.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	31	.RE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	32
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	33	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	34	.ne 2
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	35	.mk
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	36	.na
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	37	\fB\fImax_version\fR\fR
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	38	.ad
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	39	.RS 15n
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	40	.rt
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	41	The highest client plug-in version supported.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	42	.RE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	43
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	44	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	45	.ne 2
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	46	.mk
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	47	.na
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	48	\fB\fIout_version\fR\fR
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	49	.ad
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	50	.RS 15n
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	51	.rt
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	52	The client plug-in version of the result..
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	53	.RE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	54
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	55	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	56	.ne 2
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	57	.mk
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	58	.na
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	59	\fB\fIpluglist\fR\fR
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	60	.ad
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	61	.RS 15n
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	62	.rt
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	63	The list of client mechanism plug-ins.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	64	.RE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	65
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	66	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	67	.ne 2
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	68	.mk
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	69	.na
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	70	\fB\fIplugcount\fR\fR
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	71	.ad
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	72	.RS 15n
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	73	.rt
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	74	The number of client mechanism plug-ins.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	75	.RE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	76
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	77	.SH RETURN VALUES
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	78	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	79	.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	80	Like other SASL callback functions, \fBsasl_client_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.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	81	.SH ERRORS
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	82	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	83	.ne 2
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	84	.mk
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	85	.na
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	86	\fB\fBSASL_OK\fR\fR
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	87	.ad
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	88	.RS 11n
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	89	.rt
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	90	The call to \fBsasl_client_plug_init_t()\fR was successful.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	91	.RE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	92
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	93	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	94	.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	95	See \fBsasl_errors\fR(3SASL) for information on SASL error codes.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	96	.SH ATTRIBUTES
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	97	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	98	.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	99	See \fBattributes\fR(5) for descriptions of the following attributes:
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	100	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	101
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	102	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	103	.TS
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	104	tab() box;
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	105	cw(2.75i) \|cw(2.75i)
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	106	lw(2.75i) \|lw(2.75i)
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	107	.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	108	ATTRIBUTE TYPEATTRIBUTE VALUE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	109	_
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	110	Availabilitysystem/library/security/libsasl
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	111	_
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	112	Interface StabilityCommitted
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	113	_
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	114	MT-LevelMT-Safe
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	115	.TE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	116
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	117	.SH SEE ALSO
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	118	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	119	.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	120	\fBsasl_errors\fR(3SASL), \fBattributes\fR(5)

author	Jan Parcel <jan.parcel@oracle.com>
	Tue, 03 Nov 2015 14:27:41 -0800
changeset 5055	9daf220c1a9a
child 5769	6303cfed086b
permissions	-rw-r--r--