1 '\" te

     2 .\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.

     3 .\" Portions Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved

     4 .TH sasl_client_add_plugin 3SASL "12 Sep 2003" "SunOS 5.12" "Simple Authentication Security Layer Library Functions"

     5 .SH NAME

     6 sasl_client_add_plugin \- add a SASL client plug-in

     7 .SH SYNOPSIS

     8 .LP

     9 .nf

    10 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]

    11 #include <sasl/saslplug.h>

    12 

    13 \fBint\fR \fBsasl_client_add_plugin\fR(\fBconst char *\fR\fIplugname\fR,

    14      \fBsasl_client_plug_init_t *\fR\fIcplugfunc\fR);

    15 .fi

    16 

    17 .SH DESCRIPTION

    18 .sp

    19 .LP

    20 Use the \fBsasl_client_add_plugin()\fR interface to add a client plug-in to the current list of client plug-ins in the SASL library.

    21 .SH PARAMETERS

    22 .sp

    23 .ne 2

    24 .mk

    25 .na

    26 \fB\fIplugname\fR\fR

    27 .ad

    28 .RS 13n

    29 .rt  

    30 The name of the client plug-in.

    31 .RE

    32 

    33 .sp

    34 .ne 2

    35 .mk

    36 .na

    37 \fB\fIcplugfunc\fR\fR

    38 .ad

    39 .RS 13n

    40 .rt  

    41 The value of \fIcplugfunc\fR is filled in by the \fBsasl_client_plug_init_t\fR structure.

    42 .RE

    43 

    44 .SH RETURN VALUES

    45 .sp

    46 .LP

    47 \fBsasl_client_add_plugin()\fR returns an integer that corresponds to a SASL error code.

    48 .SH ERRORS

    49 .sp

    50 .ne 2

    51 .mk

    52 .na

    53 \fB\fBSASL_OK\fR\fR

    54 .ad

    55 .RS 16n

    56 .rt  

    57 The call to \fBsasl_client_add_plugin()\fR was successful.

    58 .RE

    59 

    60 .sp

    61 .ne 2

    62 .mk

    63 .na

    64 \fB\fBSASL_BADVERS\fR\fR

    65 .ad

    66 .RS 16n

    67 .rt  

    68 Version mismatch with plug-in.

    69 .RE

    70 

    71 .sp

    72 .ne 2

    73 .mk

    74 .na

    75 \fB\fBSASL_NOMEM\fR\fR

    76 .ad

    77 .RS 16n

    78 .rt  

    79 Memory shortage failure.

    80 .RE

    81 

    82 .sp

    83 .LP

    84 See \fBsasl_errors\fR(3SASL) for information on other SASL error codes.

    85 .SH ATTRIBUTES

    86 .sp

    87 .LP

    88 See \fBattributes\fR(5) for descriptions of the following attributes:

    89 .sp

    90 

    91 .sp

    92 .TS

    93 tab() box;

    94 cw(2.75i) |cw(2.75i) 

    95 lw(2.75i) |lw(2.75i) 

    96 .

    97 ATTRIBUTE TYPEATTRIBUTE VALUE

    98 _

    99 Availabilitysystem/library/security/libsasl

   100 _

   101 Interface StabilityCommitted

   102 _

   103 MT-LevelMT-Safe

   104 .TE

   105 

   106 .SH SEE ALSO

   107 .sp

   108 .LP

   109 \fBsasl_errors\fR(3SASL), \fBattributes\fR(5)