share/man/man3sasl/sasl_getopt_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_GETOPT_T 3SASL "Oct 27, 2003"
   9 .SH NAME
  10 sasl_getopt_t \- the SASL get option 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_getopt_t\fR(\fBvoid *\fR\fIcontext\fR, \fBconst char *\fR\fIplugin_name\fR,
  18      \fBconst char *\fR\fIoption\fR, \fBconst char **\fR\fIresult\fR, \fBunsigned *\fR\fIlen\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 The \fBsasl_getopt_t()\fR function allows a SASL configuration to be
  25 encapsulated in the caller's configuration system. Some implementations may use
  26 default configuration file(s) if this function is omitted. Configuration items
  27 are arbitrary strings and are plug-in specific.
  28 .SH PARAMETERS
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fIcontext\fR\fR
  33 .ad
  34 .RS 15n
  35 The option context from the callback record.
  36 .RE
  37
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fIplugin_name\fR\fR
  42 .ad
  43 .RS 15n
  44 The name of the plug-in. If the value of \fIplugin_name\fR is \fINULL\fR, the
  45 plug-in is a general SASL option.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fIoption\fR\fR
  52 .ad
  53 .RS 15n
  54 The name of the option.
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fIresult\fR\fR
  61 .ad
  62 .RS 15n
  63 The value of \fIresult\fR is set and persists until the next call to
  64 \fBsasl_getopt_t()\fR in the same thread. The value of \fIresult\fR is
  65 unchanged if \fIoption\fR is not found.
  66 .RE
  67
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fIlen\fR\fR
  72 .ad
  73 .RS 15n
  74 The length of \fIresult\fR. The value of \fIresult\fR can be \fINULL\fR.
  75 .RE
  76
  77 .SH RETURN VALUES
  78 .sp
  79 .LP
  80 Like other SASL callback functions, \fBsasl_getopt_t()\fR returns an integer
  81 that corresponds to a SASL error code. See <\fBsasl.h\fR> for a complete list
  82 of SASL error codes.
  83 .SH ERRORS
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBSASL_OK\fR\fR
  88 .ad
  89 .RS 11n
  90 The call to \fBsasl_getopt_t()\fR was successful.
  91 .RE
  92
  93 .sp
  94 .LP
  95 See \fBsasl_errors\fR(3SASL) for information on SASL error codes.
  96 .SH ATTRIBUTES
  97 .sp
  98 .LP
  99 See \fBattributes\fR(5) for descriptions of the following attributes:
 100 .sp
 101
 102 .sp
 103 .TS
 104 box;
 105 c | c
 106 l | l .
 107 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 108 _
 109 Interface Stability     Evolving
 110 _
 111 MT-Level        MT-Safe
 112 .TE
 113
 114 .SH SEE ALSO
 115 .sp
 116 .LP
 117 \fBsasl_errors\fR(3SASL), \fBattributes\fR(5)