Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

sasl_errstring (3sasl)

Name

sasl_errstring - readable form

Synopsis

#include <sasl/sasl.h>


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

Description

sasl_errstring(3sasl)           SASL man pages           sasl_errstring(3sasl)



NAME
       sasl_errstring - Translate a SASL return code to a human-readable form



SYNOPSIS
       #include <sasl/sasl.h>


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


DESCRIPTION
       sasl_usererr  is called to convert a SASL return code (an integer) into
       a human readable string. At this time the only  language  available  is
       american  english written by programmers (aka gobbledygook).  Note that
       a server should call sasl_usererr on a return code first if the  string
       is going to be sent to the client.

       saslerr specifies the error number to convert.

       langlist is currently unused; Use NULL.

       outlang  specifies  the  desired  RFC  1766  language for output.  NULL
       defaults to "en-us," currently the only supported language.

       It should be noted that this function is not the recommended  means  of
       extracting error code information from SASL, instead application should
       use sasl_errdetail(3SASL), which contains this information (and more)

RETURN VALUE
       Returns the string.  If langlist is NULL, US-ASCII is used.

CONFORMING TO
       RFC 4422


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+----------------------------------+
       |ATTRIBUTE TYPE |         ATTRIBUTE VALUE          |
       +---------------+----------------------------------+
       |Availability   | system/library/security/libsasl2 |
       +---------------+----------------------------------+
       |Stability      | Pass-through volatile            |
       +---------------+----------------------------------+

SEE ALSO
       sasl(3SASL), sasl_errdetail(3SASL), sasl_errors(3SASL)



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source was downloaded  from   ftp://ftp.cyrusimap.org/cyrus-sasl/cyrus-
       sasl-2.1.26.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.cyrusimap.org/sasl/.



SASL                             10 July 2001            sasl_errstring(3sasl)