libssh2_userauth_banner.3 (1096B)
1.TH libssh2_userauth_banner 3 "1 Jun 2021" "libssh2 1.9.0" "libssh2" 2.SH NAME 3libssh2_userauth_banner - get the server's userauth banner message 4.SH SYNOPSIS 5.nf 6#include <libssh2.h> 7 8int 9libssh2_userauth_banner(LIBSSH2_SESSION *session, char **banner); 10.fi 11.SH DESCRIPTION 12\fIsession\fP - Session instance as returned by 13.BR libssh2_session_init_ex(3) 14 15\fIbanner\fP - Should point to a pointer that gets filled with banner message. 16 17After an authentication has been attempted, such as a 18\fBSSH_USERAUTH_NONE\fP request sent by 19.BR libssh2_userauth_list(3) , 20this function can be called to retrieve the userauth banner sent by 21the server. If no such banner is sent, or if an authentication has not 22yet been attempted, returns LIBSSH2_ERROR_MISSING_USERAUTH_BANNER. 23.SH RETURN VALUE 24On success returns 0 and an UTF-8 NUL-terminated string is stored in the 25\fIbanner\fP. This string is internally managed by libssh2 and will be 26deallocated upon session termination. 27On failure returns 28LIBSSH2_ERROR_MISSING_USERAUTH_BANNER. 29.SH SEE ALSO 30.BR libssh2_session_init_ex(3), 31.BR libssh2_userauth_list(3)