usr/src/man/man3sasl/sasl_global_listmech.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_GLOBAL_LISTMECH 3SASL "Oct 1, 2003"
   9 .SH NAME
  10 sasl_global_listmech \- retrieve a list of the supported SASL mechanisms
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
  15 #include <sasl/sasl.h>
  16
  17 \fBconst char **\fR \fBsasl_global_listmech\fR(\fB\fR \fI \fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBsasl_global_listmech()\fR interface to returns a null-terminated array
  24 of strings that lists all of the mechanisms that are loaded by either the
  25 client or server side of the library.
  26 .SH RETURN VALUES
  27 .sp
  28 .LP
  29 A successful call to \fBsasl_global_listmech()\fR returns a pointer the array.
  30 On failure, \fINULL\fR is returned. The SASL library is uninitialized.
  31 .SH ATTRIBUTES
  32 .sp
  33 .LP
  34 See \fBattributes\fR(5) for descriptions of the following attributes:
  35 .sp
  36
  37 .sp
  38 .TS
  39 box;
  40 c | c
  41 l | l .
  42 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  43 _
  44 Interface Stability     Obsolete
  45 _
  46 MT-Level        MT-Safe
  47 .TE
  48
  49 .SH SEE ALSO
  50 .sp
  51 .LP
  52 \fBattributes\fR(5)