.\" Man page generated from reStructuredText.
.
.TH "SASL_CHALPROMPT_T" "3" "November 08, 2018" "2.1.27" "Cyrus SASL"
.SH NAME
sasl_chalprompt_t \- 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/prop.h>

int sasl_chalprompt_t(void *context, int id,
    const char *challenge,
    const char *prompt, const char *defresult,
    const char **result, unsigned *len)
.fi
.SH DESCRIPTION
.INDENT 0.0
.TP
.B int sasl_chalprompt_t(void *context,
.TP
.B int id,
.TP
.B const char *challenge,
.TP
.B const char *prompt,
.TP
.B const char *defresult,
.TP
.B const char **result,
.TP
.B unsigned *len)
\fBsasl_chalprompt_t\fP  is used to prompt for input in response to a server challenge.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcontext\fP – is the context from the callback record
.IP \(bu 2
\fBid\fP – is the callback id (either SASL_CB_ECHOPROMPT or  SASL_CB_NOECHOPROMPT)
.IP \(bu 2
\fBchallenge\fP – the server’s challenge
.IP \(bu 2
\fBprompt\fP – A prompt for the user
.IP \(bu 2
\fBdefresult\fP – Default result (may be NULL)
.IP \(bu 2
\fBlen\fP – Length of the user’s response.
.UNINDENT
.TP
.B Result
The user’s response (a NUL terminated string) or SASL error code.
.UNINDENT
.UNINDENT
.SH RETURN VALUE
.sp
The user’s response (NUL terminated), or a SASL error code. See sasl_errors(3)\&.
.SH SEE ALSO
.sp
sasl(3), sasl_errors(3), sasl_callbacks(3)
.SH AUTHOR
The Cyrus Team
.SH COPYRIGHT
1993-2016, The Cyrus Team
.\" Generated by docutils manpage writer.
.