usr/src/man/man3sasl/sasl_client_add_plugin.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_ADD_PLUGIN 3SASL "Sep 12, 2003"
   9 .SH NAME
  10 sasl_client_add_plugin \- add a SASL client plug-in
  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_add_plugin\fR(\fBconst char *\fR\fIplugname\fR,
  18      \fBsasl_client_plug_init_t *\fR\fIcplugfunc\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 Use the \fBsasl_client_add_plugin()\fR interface to add a client plug-in to the
  25 current list of client plug-ins in the SASL library.
  26 .SH PARAMETERS
  27 .sp
  28 .ne 2
  29 .na
  30 \fB\fIplugname\fR\fR
  31 .ad
  32 .RS 13n
  33 The name of the client plug-in.
  34 .RE
  35
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fIcplugfunc\fR\fR
  40 .ad
  41 .RS 13n
  42 The value of \fIcplugfunc\fR is filled in by the \fBsasl_client_plug_init_t\fR
  43 structure.
  44 .RE
  45
  46 .SH RETURN VALUES
  47 .sp
  48 .LP
  49 \fBsasl_client_add_plugin()\fR returns an integer that corresponds to a SASL
  50 error code.
  51 .SH ERRORS
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fBSASL_OK\fR\fR
  56 .ad
  57 .RS 16n
  58 The call to \fBsasl_client_add_plugin()\fR was successful.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBSASL_BADVERS\fR\fR
  65 .ad
  66 .RS 16n
  67 Version mismatch with plug-in.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fBSASL_NOMEM\fR\fR
  74 .ad
  75 .RS 16n
  76 Memory shortage failure.
  77 .RE
  78
  79 .sp
  80 .LP
  81 See \fBsasl_errors\fR(3SASL) for information on other SASL error codes.
  82 .SH ATTRIBUTES
  83 .sp
  84 .LP
  85 See \fBattributes\fR(5) for descriptions of the following attributes:
  86 .sp
  87
  88 .sp
  89 .TS
  90 box;
  91 c | c
  92 l | l .
  93 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  94 _
  95 Interface Stability     Evolving
  96 _
  97 MT-Level        MT-Safe
  98 .TE
  99
 100 .SH SEE ALSO
 101 .sp
 102 .LP
 103 \fBsasl_errors\fR(3SASL), \fBattributes\fR(5)