Current File : //usr/man/man3sasl/sasl_getopt_t.3sasl

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

\fBint\fR \fBsasl_getopt_t\fR(\fBvoid *\fR\fIcontext\fR, \fBconst char *\fR\fIplugin_name\fR,
     \fBconst char *\fR\fIoption\fR, \fBconst char **\fR\fIresult\fR, \fBunsigned *\fR\fIlen\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBsasl_getopt_t()\fR function allows a SASL configuration to be encapsulated in the caller's configuration system. Some implementations may use default configuration file(s) if this function is omitted. Configuration items are arbitrary strings and are plug-in specific.
.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIcontext\fR\fR
.ad
.RS 15n
.rt  
The option context from the callback record.
.RE

.sp
.ne 2
.mk
.na
\fB\fIplugin_name\fR\fR
.ad
.RS 15n
.rt  
The name of the plug-in. If the value of \fIplugin_name\fR is \fINULL\fR, the the plug-in is a general SASL option.
.RE

.sp
.ne 2
.mk
.na
\fB\fIoption\fR\fR
.ad
.RS 15n
.rt  
The name of the option.
.RE

.sp
.ne 2
.mk
.na
\fB\fIresult\fR\fR
.ad
.RS 15n
.rt  
The value of \fIresult\fR is set and persists until the next call to \fBsasl_getopt_t()\fR in the same thread. The value of \fIresult\fR is unchanged if \fIoption\fR is not found.
.RE

.sp
.ne 2
.mk
.na
\fB\fIlen\fR\fR
.ad
.RS 15n
.rt  
The length of \fIresult\fR. The value of \fIresult\fR can be \fINULL\fR. 
.RE

.SH RETURN VALUES
.sp
.LP
Like other SASL callback functions, \fBsasl_getopt_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_getopt_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)