opensolaris man page for sasl_errstring

sasl_errstring(3SASL)			      Simple Authentication Security Layer Library Functions			     sasl_errstring(3SASL)

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_errde-
       tail(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 TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Availability		     |SUNWlibsasl		   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Evolving			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Safe			   |
       +-----------------------------+-----------------------------+

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.

SunOS 5.11							    14 Oct 2003 					     sasl_errstring(3SASL)