Current File : //usr/man/man3sasl/sasl_getrealm_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_getrealm_t 3SASL "27 Oct 2003" "SunOS 5.11" "Simple Authentication Security Layer Library Functions"
.SH NAME
sasl_getrealm_t \- the realm acquisition callback function
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
#include <sasl/sasl.h>

\fBint\fR \fBsasl_getrealm_t\fR(\fBvoid *\fR\fIcontext\fR, \fBint\fR \fIid\fR, \fBconst char **\fR\fIavailrealms\fR,
     \fBconst char **\fR\fIresult\fR);
.fi

.SH DESCRIPTION
.sp
.LP
Use the \fBsasl_getrealm_t()\fR functionwhen there is an interaction with \fBSASL_CB_GETREALM\fR as the type.
.sp
.LP
If a mechanism would use this callback, but it is not present, then the first realm listed is automatically selected. A mechanism can still force the existence of a getrealm callback by \fBSASL_CB_GETREALM\fR to its \fBrequired_prompts\fR list.
.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIcontext\fR\fR
.ad
.RS 15n
.rt  
The context from the callback record
.RE

.sp
.ne 2
.mk
.na
\fB\fIid\fR\fR
.ad
.RS 15n
.rt  
The callback ID (\fBSASL_CB_GETREALM\fR)
.RE

.sp
.ne 2
.mk
.na
\fB\fIavailrealms\fR\fR
.ad
.RS 15n
.rt  
A string list of the vailable realms. \fIavailrealms\fR is a null-terminated sting that can be empty.
.RE

.sp
.ne 2
.mk
.na
\fB\fIresult\fR\fR
.ad
.RS 15n
.rt  
The chosen realm. \fIresult\fR is a null-terminated string.
.RE

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