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

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_getcallback_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_getcallback_t \- callback function to lookup a sasl_callback_t for a connection
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_getcallback_t\fR(\fBsasl_conn_t *\fR\fIconn\fR, \fBunsigned long\fR \fIcallbacknum\fR,
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	14	\fBint\fR \fI(proc)\fR( ), \fBvoid \fR\fIpcontext\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_getcallback_t()\fR function is a callback to lookup a sasl_callback_t for a connection.
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\fIconn\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 connection to lookup a callback for.
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\fIcallbacknum\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 number of the callback.
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\fIproc\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	Pointer to the callback function. The value of \fIproc\fR is set to \fINULL\fR upon failure.
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\fIpcontext\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	Pointer to the callback context. The value of \fIpcontext\fR is set to \fINULL\fR upon failure.
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	.SH RETURN VALUES
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	67	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	68	.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	69	Like other SASL callback functions, \fBsasl_getcallback_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	70	.SH ERRORS
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_OK\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 17n
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	The call to \fBsasl_getcallback_t()\fR was successful.
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	.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_FAIL\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 17n
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	Unable to find a callback of the requested type.
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	.ne 2
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	95	.mk
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	96	.na
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	97	\fB\fBSASL_INTERACT\fR\fR
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	98	.ad
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	99	.RS 17n
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	100	.rt
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	101	The caller must use interaction to get data.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	102	.RE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	103
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	104	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	105	.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	106	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	107	.SH ATTRIBUTES
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	108	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	109	.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	110	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	111	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	112
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	113	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	114	.TS
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	115	tab() box;
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	116	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	117	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	118	.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	119	ATTRIBUTE TYPEATTRIBUTE VALUE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	120	_
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	121	Availabilitysystem/library/security/libsasl
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	122	_
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	123	Interface StabilityCommitted
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	124	_
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	125	MT-LevelMT-Safe
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	126	.TE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	127
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	128	.SH SEE ALSO
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	129	.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	130	.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update Jan Parcel <jan.parcel@oracle.com> parents: diff changeset	131	\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--