lib/libssh
1
0
Fork 0
mirror of https://git.libssh.org/projects/libssh.git synced 2025-11-29 01:03:57 +03:00
Code Activity

auth: Improve doc of ssh_userauth_kbdint_getprompt().

Browse Source
This commit is contained in:
Andreas Schneider
2012-02-19 13:13:59 +01:00
parent b7507fc85e
commit 72001ff8cc
1 changed files with 11 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/auth.c
View File

@@ -1979,11 +1979,19 @@ const char *ssh_userauth_kbdint_getinstruction(ssh_session session) {
* *
* @param[in] i The index number of the i'th prompt. * @param[in] i The index number of the i'th prompt.
* *
* @param[in] echo When different of NULL, it will obtain a boolean meaning * @param[out] echo This is an optional variable. You can obtain a
* that the resulting user input should be echoed or not * boolean if the user input should be echoed or
* (like passwords). * hidden. For passwords it is usually hidden.
* *
* @returns A pointer to the prompt. Do not free it. * @returns A pointer to the prompt. Do not free it.
*
* @code
* const char prompt;
* char echo;
*
* prompt = ssh_userauth_kbdint_getprompt(session, 0, &echo);
* if (echo) ...
* @endcode
*/ */
const char *ssh_userauth_kbdint_getprompt(ssh_session session, unsigned int i, const char *ssh_userauth_kbdint_getprompt(ssh_session session, unsigned int i,
char *echo) { char *echo) {