DragonFly On-Line Manual Pages

Search: Section:  

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

       const char * sasl_errstring(int saslerr,

       const char * langlist,

       const char ** outlang);
	      sasl_errstring is called to convert a SASL return code (an inte-
	      ger) into a human readable string. At this time  the  only  lan-
	      guage  available is American English. Note that if the string is
	      going to be sent to the client, a server should call  sasl_user-
	      err(3) on a return code first.

	      Parameters

		     o saslerr a specifies the error number to convert.

		     o langlist a is currently unused; Use NULL.

		     o outlang	a specifies  the desired RFC 1766 language for
		       output.	NULL defaults to aenausa; 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,  USaASCII  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

2.1.27			       November 08, 2018	     SASL_ERRSTRING(3)

Search: Section: