1.. saslman:: sasl_errstring(3)
2
3.. _sasl-reference-manpages-library-sasl_errstring:
4
5
6==========================================================================
7**sasl_errstring** - Translate a SASL return code to a human-readable form
8==========================================================================
9
10Synopsis
11========
12
13.. code-block:: C
14
15    #include <sasl/sasl.h>
16
17    const char * sasl_errstring(int saslerr,
18        const char * langlist,
19        const char ** outlang);
20
21Description
22===========
23
24.. c:function::  const char * sasl_errstring(int saslerr,
25        const char * langlist,
26        const char ** outlang);
27
28    **sasl_errstring** is called to convert a SASL return code (an
29    integer) into a human readable string. At this time the
30    only language available is American English. Note that if the string is
31    going to be sent to the client, a server should
32    call :saslman:`sasl_usererr(3)` on a return code first.
33
34    :param saslerr: specifies the error number to convert.
35
36    :param langlist: is currently unused; Use NULL.
37
38    :param outlang:  specifies  the desired :rfc:`1766` language for
39        output.  NULL defaults to "en‐us"; currently the only supported
40        language.
41
42    This function is not the recommended means of extracting error code
43    information from SASL,  instead  application  should use
44    :saslman:`sasl_errdetail(3)`, which contains this information (and more).
45
46Return Value
47============
48
49Returns the string.  If  langlist  is  NULL,  US‐ASCII  is used.
50
51See Also
52========
53
54:rfc:`4422`,:saslman:`sasl(3)`, :saslman:`sasl_errdetail(3)`,
55:saslman:`sasl_errors(3)`
56