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