Current File : //proc/thread-self/root/opt/alt/cyrus-sasl/share/man/man3/sasl_errstring.3
.\" Man page generated from reStructuredText.
.
.TH "SASL_ERRSTRING" "3" "November 08, 2018" "2.1.27" "Cyrus SASL"
.SH NAME
sasl_errstring \- Cyrus SASL documentation
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
.nf
#include <sasl/sasl.h>
const char * sasl_errstring(int saslerr,
const char * langlist,
const char ** outlang);
.fi
.SH DESCRIPTION
.INDENT 0.0
.TP
.B const char * sasl_errstring(int saslerr,
.TP
.B const char * langlist,
.TP
.B const char ** outlang);
\fBsasl_errstring\fP 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.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsaslerr\fP – specifies the error number to convert.
.IP \(bu 2
\fBlanglist\fP – is currently unused; Use NULL.
.IP \(bu 2
\fBoutlang\fP – specifies the desired \fI\%RFC 1766\fP language for
output. NULL defaults to “en‐us”; currently the only supported
language.
.UNINDENT
.UNINDENT
.sp
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).
.UNINDENT
.SH RETURN VALUE
.sp
Returns the string. If langlist is NULL, US‐ASCII is used.
.SH SEE ALSO
.sp
\fI\%RFC 4422\fP,:saslman:\fIsasl(3)\fP, sasl_errdetail(3),
sasl_errors(3)
.SH AUTHOR
The Cyrus Team
.SH COPYRIGHT
1993-2016, The Cyrus Team
.\" Generated by docutils manpage writer.
.
Mini Shell