Man page - sasl_errstring(3)

Packages contains this manual

Package:  libsasl2-dev
apt-get install libsasl2-dev

Manuals in package:
• sasl_listmech(3)
• sasl_server_new(3)
• sasl_getconfpath_t(3)
• sasl(3)
• sasl_server_userdb_checkpass_t(3)
• sasl_authorize_t(3)
• sasl_server_step(3)
• sasl_setpass(3)
• sasl_server_init(3)
• sasl_idle(3)
• sasl_user_exists(3)
• sasl_checkpass(3)
• sasl_errors(3)
• sasl_auxprop_request(3)
• sasl_getopt_t(3)
• sasl_getprop(3)
• sasl_encodev(3)
• sasl_callbacks(3)
• sasl_getrealm_t(3)
• sasl_encode(3)
• sasl_client_init(3)
• sasl_client_new(3)
• sasl_done(3)
• sasl_decode(3)
• sasl_server_userdb_setpass_t(3)
• sasl_checkapop(3)
• sasl_client_step(3)
• sasl_server_start(3)
• sasl_chalprompt_t(3)
• sasl_dispose(3)
• sasl_canon_user_t(3)
• sasl_client_start(3)
• sasl_global_listmech(3)
• sasl_getsecret_t(3)
• sasl_getsimple_t(3)
• sasl_verifyfile_t(3)
• sasl_getpath_t(3)
• sasl_errdetail(3)
• sasl_setprop(3)
• sasl_auxprop_getctx(3)
• sasl_auxprop(3)
• sasl_errstring(3)
• sasl_log_t(3)
Documentations in package:
• libsasl2-dev

Manual

SASL_ERRSTRING

NAME
SYNOPSIS
DESCRIPTION
RETURN VALUE
SEE ALSO
AUTHOR
COPYRIGHT

---

NAME

sasl_errstring - Cyrus SASL documentation

SYNOPSIS

#include <sasl/sasl.h>

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

DESCRIPTION

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

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) on a return code first.
Parameters

	•		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.

This function is not the recommended means of extracting error code information from SASL, instead application should use 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 ,:saslman: sasl(3) , sasl_errdetail(3) , sasl_errors(3)

AUTHOR

The Cyrus Team

COPYRIGHT

1993-2016, The Cyrus Team

---