'\" te
.\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.
.\" Portions Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved
.TH sasl_getsimple_t 3SASL "27 Oct 2003" "SunOS 5.11" "Simple Authentication Security Layer Library Functions"
.SH NAME
sasl_getsimple_t \- the SASL callback function for username, authname and realm
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
#include <sasl/sasl.h>

\fBint\fR \fBsasl_getsimple_t\fR(\fBvoid *\fR\fIcontext\fR, \fBint\fR \fIid\fR, \fBconst char **\fR\fIresult\fR,
     \fBunsigned *\fR\fIlen\fR);
.fi

.SH DESCRIPTION
.sp
.LP
Use the \fBsasl_getsimple_t()\fR callback function to retrieve simple data from the application such as the authentication name, the authorization name, and the realm. The \fIid\fR parameter indicates which value is requested. 
.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIcontext\fR\fR
.ad
.RS 11n
.rt  
The context from the callback structure.
.RE

.sp
.ne 2
.mk
.na
\fB\fIid\fR\fR
.ad
.RS 11n
.rt  
The callback ID. Possible values for \fIid\fR include:
.sp
.ne 2
.mk
.na
\fB\fBSASL_CB_USER\fR\fR
.ad
.RS 20n
.rt  
Client user identity for login.
.RE

.sp
.ne 2
.mk
.na
\fB\fBSASL_CB_AUTHNAME\fR\fR
.ad
.RS 20n
.rt  
Client authentication name.
.RE

.sp
.ne 2
.mk
.na
\fB\fBSASL_CB_LANGUAGE\fR\fR
.ad
.RS 20n
.rt  
Comma-separated list of languages pursuant to \fIRFC 1766\fR.
.RE

.sp
.ne 2
.mk
.na
\fB\fBSASL_CB_CNONCE\fR\fR
.ad
.RS 20n
.rt  
The client-nonce. This value is used primarily for testing.
.RE

.RE

.sp
.ne 2
.mk
.na
\fB\fIresult\fR\fR
.ad
.RS 11n
.rt  
To cancel user, set the value of \fIresult\fR with a null-terminated string. If the value of \fIresult\fR is \fINULL\fR, then the user is cancelled.
.RE

.sp
.ne 2
.mk
.na
\fB\fIlen\fR\fR
.ad
.RS 11n
.rt  
The length of \fIresult\fR.
.RE

.SH RETURN VALUES
.sp
.LP
Like other SASL callback functions, \fBsasl_getsimple_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_getsimple_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)
.sp
.LP
Alvestrand, H. \fIRFC 1766, Tags for the Identification of Languages\fR. Network Working Group. November 1995.