Editing File: /opt/alt/cyrus-sasl/share/man/man3/sasl_errdetail.3

.\" Man page generated from reStructuredText.
.
.TH "SASL_ERRDETAIL" "3" "February 18, 2022" "2.1.28" "Cyrus SASL"
.SH NAME
sasl_errdetail \- 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
..
.SH SYNOPSIS
.sp
.nf
#include <sasl/sasl.h>

const char *sasl_errdetail( sasl_conn_t *conn );
.fi
.SH DESCRIPTION
.INDENT 0.0
.TP
.B const  char  *sasl_errdetail(sasl_conn_t  *conn); 
\fBsasl_errdetail\fP provides more  detailed  information  about
the  most  recent  error  to occur, beyond the information
contained in the SASL result code.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconn\fP – the SASL connection context to inquire about.
.UNINDENT
.UNINDENT
.UNINDENT
.SH RETURN VALUE
.sp
Returns the string describing the error that occurred,  or NULL  if  no  error
has  occurred,  or there was an error retrieving it.
.SH SEE ALSO
.sp
\fI\%RFC 4422\fP,:saslman:\fIsasl(3)\fP
.SH AUTHOR
The Cyrus Team
.SH COPYRIGHT
1993-2016, The Cyrus Team
.\" Generated by docutils manpage writer.
.

Back to Directory