File: sasl_chalprompt_t.rst.txt

package info (click to toggle)
cyrus-sasl2 2.1.27%2Bdfsg-2.1%2Bdeb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 19,940 kB
  • sloc: ansic: 58,942; javascript: 8,745; sh: 4,843; java: 1,614; xml: 1,498; makefile: 1,265; python: 342; perl: 199
file content (50 lines) | stat: -rw-r--r-- 1,476 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
.. saslman:: sasl_chalprompt_t(3)

.. _sasl-reference-manpages-library-sasl_chalprompt_t:

==================================================
**sasl_chalprompt_t** - Realm acquisition callback
==================================================

Synopsis
========

.. code-block:: C

    #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)

Description
===========

.. c:function::     int sasl_chalprompt_t(void *context,
        int id,
        const char *challenge,
        const char *prompt,
        const char *defresult,
        const char **result,
        unsigned *len)

        **sasl_chalprompt_t**  is used to prompt for input in response to a server challenge.

        :param context: is the context from the callback record
        :param id: is the callback id (either SASL_CB_ECHOPROMPT or  SASL_CB_NOECHOPROMPT)
        :param challenge: the server's challenge
        :param prompt: A prompt for the user
        :param defresult: Default result (may be NULL)
        :result: The user's response (a NUL terminated string) or SASL error code.
        :param len: Length of the user's response.

Return Value
============

The user's response (NUL terminated), or a SASL error code. See :saslman:`sasl_errors(3)`.

See Also
========

:saslman:`sasl(3)`, :saslman:`sasl_errors(3)`, :saslman:`sasl_callbacks(3)`