usr/src/man/man3sasl/sasl_getcallback_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_GETCALLBACK_T 3SASL "Oct 27, 2003"
   9 .SH NAME
  10 sasl_getcallback_t \- callback function to lookup a sasl_callback_t for a
  11 connection
  12 .SH SYNOPSIS
  13 .LP
  14 .nf
  15 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
  16 #include <sasl/saslplug.h>
  17
  18 \fBint\fR \fBsasl_getcallback_t\fR(\fBsasl_conn_t *\fR\fIconn\fR, \fBunsigned long\fR \fIcallbacknum\fR,
  19      \fBint\fR \fI(**proc)\fR( ), \fBvoid **\fR\fIpcontext\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 The \fBsasl_getcallback_t()\fR function is a callback to lookup a
  26 sasl_callback_t for a connection.
  27 .SH PARAMETERS
  28 .sp
  29 .ne 2
  30 .na
  31 \fB\fIconn\fR\fR
  32 .ad
  33 .RS 15n
  34 The connection to lookup a callback for.
  35 .RE
  36
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fIcallbacknum\fR\fR
  41 .ad
  42 .RS 15n
  43 The number of the callback.
  44 .RE
  45
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fIproc\fR\fR
  50 .ad
  51 .RS 15n
  52 Pointer to the callback function. The value of \fIproc\fR is set to \fINULL\fR
  53 upon failure.
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fIpcontext\fR\fR
  60 .ad
  61 .RS 15n
  62 Pointer to the callback context. The value of \fIpcontext\fR is set to
  63 \fINULL\fR upon failure.
  64 .RE
  65
  66 .SH RETURN VALUES
  67 .sp
  68 .LP
  69 Like other SASL callback functions, \fBsasl_getcallback_t()\fR returns an
  70 integer that corresponds to a SASL error code. See <\fBsasl.h\fR> for a
  71 complete list of SASL error codes.
  72 .SH ERRORS
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fBSASL_OK\fR\fR
  77 .ad
  78 .RS 17n
  79 The call to \fBsasl_getcallback_t()\fR was successful.
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fBSASL_FAIL\fR\fR
  86 .ad
  87 .RS 17n
  88 Unable to find a callback of the requested type.
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fBSASL_INTERACT\fR\fR
  95 .ad
  96 .RS 17n
  97 The caller must use interaction to get data.
  98 .RE
  99
 100 .sp
 101 .LP
 102 See \fBsasl_errors\fR(3SASL) for information on SASL error codes.
 103 .SH ATTRIBUTES
 104 .sp
 105 .LP
 106 See \fBattributes\fR(5) for descriptions of the following attributes:
 107 .sp
 108
 109 .sp
 110 .TS
 111 box;
 112 c | c
 113 l | l .
 114 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 115 _
 116 Interface Stability     Evolving
 117 _
 118 MT-Level        MT-Safe
 119 .TE
 120
 121 .SH SEE ALSO
 122 .sp
 123 .LP
 124 \fBsasl_errors\fR(3SASL), \fBattributes\fR(5)