share/man/man3sasl/sasl_errstring.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_ERRSTRING 3SASL "Oct 14, 2003"
   9 .SH NAME
  10 sasl_errstring \- translate a SASL return code to a human-readable form
  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_errstring\fR(\fBint\fR \fIsaslerr\fR, \fBconst char *\fR\fIlanglist\fR,
  18      \fBconst char **\fR\fIoutlang\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 The \fBsasl_errstring()\fR interface is called to convert a SASL return code
  25 from an integer into a human readable string.
  26 .sp
  27 .LP
  28 You should not used the \fBsasl_errstring()\fR interface to extract error code
  29 information from SASL. Applications should use \fBsasl_errdetail\fR(3SASL)
  30 instead, which contains this error information and more.
  31 .sp
  32 .LP
  33 The \fBsasl_errstring()\fR interface supports only \fBi-default\fR and
  34 \fBi-local\fR at this time.
  35 .SH PARAMETERS
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fIsaslerr\fR\fR
  40 .ad
  41 .RS 12n
  42 The error number to be translated.
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fIlanglist\fR\fR
  49 .ad
  50 .RS 12n
  51 A comma-separated list of languages. See \fIRFC 1766\fR. If the\fIlanglist\fR
  52 parameter has a\fINULL\fR value, the default language,\fBi-default\fR, is used.
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fIoutlang\fR\fR
  59 .ad
  60 .RS 12n
  61 The language actually used. The \fIoutlang\fR parameter can be \fINULL\fR. The
  62 returned error string is in \fBUTF-8\fR.
  63 .RE
  64
  65 .SH RETURN VALUES
  66 .sp
  67 .LP
  68 \fBsasl_errstring()\fR returns the string that describes the error that
  69 occurred, or \fINULL\fR, if there was an error retrieving it.
  70 .SH ATTRIBUTES
  71 .sp
  72 .LP
  73 See \fBattributes\fR(5) for descriptions of the following attributes:
  74 .sp
  75
  76 .sp
  77 .TS
  78 box;
  79 c | c
  80 l | l .
  81 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  82 _
  83 Interface Stability     Evolving
  84 _
  85 MT-Level        Safe
  86 .TE
  87
  88 .SH SEE ALSO
  89 .sp
  90 .LP
  91 \fBsasl_errors\fR(3SASL), \fBsasl_seterror\fR(3SASL), \fBattributes\fR(5)
  92 .sp
  93 .LP
  94 Alvestrand, H. \fIRFC 1766, Tags for the Identification of Languages\fR.
  95 Network Working Group. November 1995.