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

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_seterror 3SASL "14 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_seterror \- set the error string
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/sasl.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	\fBvoid\fR \fBsasl_seterror\fR(\fBsasl_conn_t *\fR\fIconn\fR, \fBunsigned\fR \fIflags\fR,
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	14	\fBconst char *\fR\fIfmt\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_seterror()\fR interface sets the error string that will be returned by \fBsasl_errdetail\fR(3SASL). Use \fBsyslog\fR(3C) style formatting, that is, use \fBprintf()\fR\(emstyle with \fB%m\fR as the most recent \fBerrno\fR error.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	21	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	22	.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	23	The \fBsasl_seterror()\fR interface is primarily used by server callback functions and internal plug-ins, for example, with the \fBsasl_authorize_t\fR callback. The \fBsasl_seterror()\fR interface triggers a call to the SASL logging callback, if any, with a level of \fBSASL_LOG_FAIL\fR, unless the \fBSASL_NOLOG\fR flag is set.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	24	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	25	.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	26	Make the message string sensitive to the current language setting. If there is no \fBSASL_CB_LANGUAGE\fR callback, message strings must be \fBi-default\fR. Otherwise, UTF-8 is used. Use of \fIRFC 2482\fR for mixed-language text is encouraged.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	27	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	28	.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	29	If the value of \fIconn\fR is \fINULL\fR, the \fBsasl_seterror()\fR interface fails.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	30	.SH PARAMETERS
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	31	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	32	.ne 2
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	33	.mk
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	34	.na
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	35	\fB\fIconn\fR\fR
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	36	.ad
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	37	.RS 9n
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	38	.rt
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	39	The \fBsasl_conn_t\fR for which the call to \fBsasl_seterror()\fR applies.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	40	.RE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	41
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	42	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	43	.ne 2
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	44	.mk
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	45	.na
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	46	\fB\fIflags\fR\fR
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	47	.ad
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	48	.RS 9n
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	49	.rt
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	50	If set to \fBSASL_NOLOG\fR, the call to \fBsasl_seterror()\fR is not logged.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	51	.RE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	52
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	53	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	54	.ne 2
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	55	.mk
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	56	.na
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	57	\fB\fIfmt\fR\fR
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	58	.ad
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	59	.RS 9n
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	60	.rt
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	61	A \fBsyslog\fR(3C) style format string.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	62	.RE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	63
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	64	.SH RETURN VALUES
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	65	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	66	.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	67	\fBsasl_seterror()\fR has no return values.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	68	.SH ATTRIBUTES
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	69	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	70	.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	71	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	72	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	73
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	74	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	75	.TS
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	76	tab() box;
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	77	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	78	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	79	.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	80	ATTRIBUTE TYPEATTRIBUTE VALUE
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	Availabilitysystem/library/security/libsasl
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	83	_
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	84	Interface StabilityCommitted
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	85	_
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	86	MT-LevelMT-Safe
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	87	.TE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	88
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	89	.SH SEE ALSO
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	90	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	91	.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	92	\fBsasl_errdetail\fR(3SASL), \fBsyslog\fR(3C), \fBattributes\fR(5)
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	Whistler, K. and Adams, G. \fIRFC 2482, Language Tagging in Unicode Plain Text\fR. Network Working Group. January 1999.

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--