xref: /titanic_41/usr/src/man/man3sasl/sasl_errstring.3sasl (revision e65fcc69bb33b3f4525b0c2c9732ece17c90b196) 
 te
 Copyright (C) 1998-2003, Carnegie Mellon Univeristy. All Rights Reserved.
 Portions Copyright (C) 2003, Sun Microsystems,
 Inc. All Rights Reserved
 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.
 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.
 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]
 sasl_errstring 3SASL "14 Oct 2003" "SunOS 5.11" "Simple Authentication Security Layer Library Functions"
 NAME
sasl_errstring - translate a SASL return code to a human-readable form

 SYNOPSIS


cc [ flag ... ] file ... -lsasl [ library ... ]
#include <sasl/sasl.h>

const char * sasl_errstring(int saslerr, const char *langlist,
 const char **outlang);




 DESCRIPTION

The sasl_errstring() interface is called to convert a SASL return code
from an integer into a human readable string.


You should not used the sasl_errstring() interface to extract error code
information from SASL. Applications should use sasl_errdetail(3SASL)
instead, which contains this error information and more.


The sasl_errstring() interface supports only i-default and
i-local at this time.

 PARAMETERS

saslerr


The error number to be translated.





langlist


A comma-separated list of languages. See RFC 1766. If thelanglist
parameter has aNULL value, the default language,i-default, is used.





outlang


The language actually used. The outlang parameter can be NULL. The
returned error string is in UTF-8.




 RETURN VALUES

sasl_errstring() returns the string that describes the error that
occurred, or NULL, if there was an error retrieving it.

 ATTRIBUTES

See attributes(5) for descriptions of the following attributes:







ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityEvolving
MT-LevelSafe



 SEE ALSO

sasl_errors(3SASL), sasl_seterror(3SASL), attributes(5)


Alvestrand, H. RFC 1766, Tags for the Identification of Languages.
Network Working Group. November 1995.