usr/src/man/man3sasl/sasl_client_plug_init_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_CLIENT_PLUG_INIT_T 3SASL "Oct 27, 2003"
   9 .SH NAME
  10 sasl_client_plug_init_t \- client plug-in entry point
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
  15 #include <sasl/saslplug.h>
  16
  17 \fBint\fR \fBsasl_client_plug_init_t\fR(\fBconst sasl_utils_t *\fR\fIutils\fR, \fBint\fR \fImax_version\fR,
  18      \fBint *\fR\fIout_version\fR, \fBsasl_client_plug_t **\fR\fIpluglist\fR, \fBint *\fR\fIplugcount\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 The \fBsasl_client_plug_init_t()\fR callback function is the client plug-in
  25 entry point.
  26 .SH PARAMETERS
  27 .sp
  28 .ne 2
  29 .na
  30 \fB\fIutils\fR\fR
  31 .ad
  32 .RS 15n
  33 The utility callback functions.
  34 .RE
  35
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fImax_version\fR\fR
  40 .ad
  41 .RS 15n
  42 The highest client plug-in version supported.
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fIout_version\fR\fR
  49 .ad
  50 .RS 15n
  51 The client plug-in version of the result..
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fIpluglist\fR\fR
  58 .ad
  59 .RS 15n
  60 The list of client mechanism plug-ins.
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fIplugcount\fR\fR
  67 .ad
  68 .RS 15n
  69 The number of client mechanism plug-ins.
  70 .RE
  71
  72 .SH RETURN VALUES
  73 .sp
  74 .LP
  75 Like other SASL callback functions, \fBsasl_client_plug_init_t()\fR returns an
  76 integer that corresponds to a SASL error code. See <\fBsasl.h\fR> for a
  77 complete list of SASL error codes.
  78 .SH ERRORS
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBSASL_OK\fR\fR
  83 .ad
  84 .RS 11n
  85 The call to \fBsasl_client_plug_init_t()\fR was successful.
  86 .RE
  87
  88 .sp
  89 .LP
  90 See \fBsasl_errors\fR(3SASL) for information on SASL error codes.
  91 .SH ATTRIBUTES
  92 .sp
  93 .LP
  94 See \fBattributes\fR(5) for descriptions of the following attributes:
  95 .sp
  96
  97 .sp
  98 .TS
  99 box;
 100 c | c
 101 l | l .
 102 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 103 _
 104 Interface Stability     Evolving
 105 _
 106 MT-Level        MT-Safe
 107 .TE
 108
 109 .SH SEE ALSO
 110 .sp
 111 .LP
 112 \fBsasl_errors\fR(3SASL), \fBattributes\fR(5)