1SASL_ERRSTRING(3)                 Cyrus SASL                 SASL_ERRSTRING(3)
2
3
4

NAME

6       sasl_errstring - Cyrus SASL documentation
7

SYNOPSIS

9       #include <sasl/sasl.h>
10
11       const char * sasl_errstring(int saslerr,
12           const char * langlist,
13           const char ** outlang);
14

DESCRIPTION

16       const char * sasl_errstring(int saslerr,
17
18       const char * langlist,
19
20       const char ** outlang);
21              sasl_errstring is called to convert a SASL return code (an inte‐
22              ger) into a human readable string. At this time  the  only  lan‐
23              guage  available is American English. Note that if the string is
24              going to be sent to the client, a server should call  sasl_user‐
25              err(3) on a return code first.
26
27              Parameters
28
29                     • saslerr – specifies the error number to convert.
30
31                     • langlist – is currently unused; Use NULL.
32
33                     • outlang  – specifies  the desired RFC 1766 language for
34                       output.  NULL defaults to “en‐us”; currently  the  only
35                       supported language.
36
37              This  function  is not the recommended means of extracting error
38              code information from SASL,  instead   application   should  use
39              sasl_errdetail(3), which contains this information (and more).
40

RETURN VALUE

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

SEE ALSO

45       RFC 4422,:saslman:sasl(3), sasl_errdetail(3), sasl_errors(3)
46

AUTHOR

48       The Cyrus Team
49

51       1993-2016, The Cyrus Team
52
53
54
55
562.1.28                         February 18, 2022             SASL_ERRSTRING(3)
Impressum