Changeset 63 in openpam for trunk/lib/pam_vprompt.c


Ignore:
Timestamp:
Feb 18, 2002, 7:31:10 PM (19 years ago)
Author:
Dag-Erling Smørgrav
Message:

Add in-line documentation. Some functions still lack descriptions.

Sponsored by: DARPA, NAI Labs

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/lib/pam_vprompt.c

    r57 r63  
    7878        return (r);
    7979}
     80
     81/*
     82 * Error codes:
     83 *
     84 *     !PAM_SYMBOL_ERR
     85 *      PAM_SYSTEM_ERR
     86 *      PAM_BUF_ERR
     87 *      PAM_CONV_ERR
     88 */
     89
     90/**
     91 * The =pam_vprompt function constructs a string from the =fmt and =ap
     92 * arguments using =vsnprintf, and passes it to the given PAM context's
     93 * conversation function.
     94 *
     95 * The =style argument specifies the type of interaction requested, and
     96 * must be one of the following:
     97 *
     98 *      =PAM_PROMPT_ECHO_OFF:
     99 *              Display the message and obtain the user's response without
     100 *              displaying it.
     101 *      =PAM_PROMPT_ECHO_ON:
     102 *              Display the message and obtain the user's response.
     103 *      =PAM_ERROR_MSG:
     104 *              Display the message as an error message, and do not wait
     105 *              for a response.
     106 *      =PAM_TEXT_INFO:
     107 *              Display the message as an informational message, and do
     108 *              not wait for a response.
     109 *
     110 * A pointer to the response, or =NULL if the conversation function did
     111 * not return one, is stored in the location pointed to by the =resp
     112 * argument.
     113 *
     114 * The message and response should not exceed =PAM_MAX_MSG_SIZE or
     115 * =PAM_MAX_RESP_SIZE, respectively.
     116 * If they do, they may be truncated.
     117 *
     118 * >pam_error
     119 * >pam_info
     120 * >pam_prompt
     121 * >pam_verror
     122 * >pam_vinfo
     123 */
Note: See TracChangeset for help on using the changeset viewer.