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

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_canonuser_add_plugin 3SASL "16 Sep 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_canonuser_add_plugin \- add a SASL user canonicalization plug-in
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_canonuser_add_plugin\fR(\fBconst char *\fR\fIplugname\fR,
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	14	\fBsasl_canonuser_plug_init_t *\fR\fIcplugfunc\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	Use the \fBsasl_canonuser_add_plugin()\fR interface to add a user canonicalization plug-in to the current list of user canonicalization plug-ins in the SASL library.
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\fIplugname\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 13n
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 name of the user canonicalization plug-in.
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\fIcplugfunc\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 13n
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 value of \fIcplugfunc\fR is filled in by the \fBsasl_canonuser_plug_init_t\fR structure.
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	.SH RETURN VALUES
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	45	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	46	.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	47	\fBsasl_server_add_plugin()\fR returns an integer that corresponds to a SASL error code.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	48	.SH ERRORS
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	49	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	50	.ne 2
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	51	.mk
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	52	.na
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	53	\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	54	.ad
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	55	.RS 16n
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	56	.rt
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	57	The call to \fBsasl_client_add_plugin()\fR was successful.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	58	.RE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	59
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	60	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	61	.ne 2
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	62	.mk
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	63	.na
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	64	\fB\fBSASL_BADVERS\fR\fR
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	65	.ad
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	66	.RS 16n
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	67	.rt
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	68	Version mismatch with plug-in.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	69	.RE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	70
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	71	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	72	.ne 2
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	73	.mk
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	74	.na
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	75	\fB\fBSASL_NOMEM\fR\fR
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	76	.ad
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	77	.RS 16n
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	78	.rt
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	79	Memory shortage failure.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	80	.RE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	81
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	.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	84	See \fBsasl_errors\fR(3SASL) for information on other SASL error codes.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	85	.SH ATTRIBUTES
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	86	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	87	.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	88	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	89	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	90
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	91	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	92	.TS
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	93	tab() box;
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	94	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	95	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	96	.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	97	ATTRIBUTE TYPEATTRIBUTE VALUE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	98	_
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	99	Availabilitysystem/library/security/libsasl
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	100	_
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	101	Interface StabilityCommitted
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	102	_
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	103	MT-LevelMT-Safe
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	104	.TE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	105
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	106	.SH SEE ALSO
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	107	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	108	.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	109	\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--