share/man/man3sasl/sasl_getrealm_t.3sasl

   1 '\" te
   2 .\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.
   3 .\" Portions Copyright (C) 2003, Sun Microsystems,
   4 .\" Inc. All Rights Reserved
   5 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   6 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   7 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   8 .TH SASL_GETREALM_T 3SASL "Oct 27, 2003"
   9 .SH NAME
  10 sasl_getrealm_t \- the realm acquisition callback function
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
  15 #include <sasl/sasl.h>
  16
  17 \fBint\fR \fBsasl_getrealm_t\fR(\fBvoid *\fR\fIcontext\fR, \fBint\fR \fIid\fR, \fBconst char **\fR\fIavailrealms\fR,
  18      \fBconst char **\fR\fIresult\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 Use the \fBsasl_getrealm_t()\fR functionwhen there is an interaction with
  25 \fBSASL_CB_GETREALM\fR as the type.
  26 .sp
  27 .LP
  28 If a mechanism would use this callback, but it is not present, then the first
  29 realm listed is automatically selected. A mechanism can still force the
  30 existence of a getrealm callback by \fBSASL_CB_GETREALM\fR to its
  31 \fBrequired_prompts\fR list.
  32 .SH PARAMETERS
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fIcontext\fR\fR
  37 .ad
  38 .RS 15n
  39 The context from the callback record
  40 .RE
  41
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fIid\fR\fR
  46 .ad
  47 .RS 15n
  48 The callback ID (\fBSASL_CB_GETREALM\fR)
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fIavailrealms\fR\fR
  55 .ad
  56 .RS 15n
  57 A string list of the vailable realms. \fIavailrealms\fR is a null-terminated
  58 sting that can be empty.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fIresult\fR\fR
  65 .ad
  66 .RS 15n
  67 The chosen realm. \fIresult\fR is a null-terminated string.
  68 .RE
  69
  70 .SH RETURN VALUES
  71 .sp
  72 .LP
  73 Like other SASL callback functions, \fBsasl_getrealm_t()\fR returns an integer
  74 that corresponds to a SASL error code. See <\fBsasl.h\fR> for a complete list
  75 of SASL error codes.
  76 .SH ERRORS
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fBSASL_OK\fR\fR
  81 .ad
  82 .RS 11n
  83 The call to \fBsasl_getrealm_t()\fR was successful.
  84 .RE
  85
  86 .sp
  87 .LP
  88 See \fBsasl_errors\fR(3SASL) for information on SASL error codes.
  89 .SH ATTRIBUTES
  90 .sp
  91 .LP
  92 See \fBattributes\fR(5) for descriptions of the following attributes:
  93 .sp
  94
  95 .sp
  96 .TS
  97 box;
  98 c | c
  99 l | l .
 100 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 101 _
 102 Interface Stability     Evolving
 103 _
 104 MT-Level        MT-Safe
 105 .TE
 106
 107 .SH SEE ALSO
 108 .sp
 109 .LP
 110 \fBsasl_errors\fR(3SASL), \fBattributes\fR(5)