Scroll to navigation

SASL_ERRSTRING(3) Cyrus SASL SASL_ERRSTRING(3)

NAME

sasl_errstring - Cyrus SASL documentation

SYNOPSIS

#include <sasl/sasl.h>
const char * sasl_errstring(int saslerr,


    const char * langlist,


    const char ** outlang);

DESCRIPTION

sasl_errstring 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. Note that if the string is going to be sent to the client, a server should call sasl_usererr(3) <#std-saslman-sasl_usererr-3> on a return code first.
  • saslerr – specifies the error number to convert.
  • langlist – is currently unused; Use NULL.
  • outlang – specifies the desired RFC 1766 <https://datatracker.ietf.org/doc/html/rfc1766.html> language for output. NULL defaults to “en‐us”; currently the only supported language.


This function is not the recommended means of extracting error code information from SASL, instead application should use sasl_errdetail(3) <#std-saslman-sasl_errdetail-3>, which contains this information (and more).


RETURN VALUE

Returns the string. If langlist is NULL, US‐ASCII is used.

SEE ALSO

RFC 4422 <https://datatracker.ietf.org/doc/html/rfc4422.html>,:saslman:sasl(3), sasl_errdetail(3) <#std-saslman-sasl_errdetail-3>, sasl_errors(3) <#std-saslman-sasl_errors-3>

Author

The Cyrus Team

Copyright

1993-2016, The Cyrus Team

2026-04-04 2.1.28