libssh2_session_banner_set.3 (1152B)
1.TH libssh2_session_banner_set 3 "9 Sep 2011" "libssh2" "libssh2" 2.SH NAME 3libssh2_session_banner_set - set the SSH protocol banner for the local client 4.SH SYNOPSIS 5.nf 6#include <libssh2.h> 7 8int 9libssh2_session_banner_set(LIBSSH2_SESSION *session, const 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 - A pointer to a zero-terminated string holding the user defined 16banner 17 18Set the banner that will be sent to the remote host when the SSH session is 19started with \fIlibssh2_session_handshake(3)\fP This is optional; a banner 20corresponding to the protocol and libssh2 version will be sent by default. 21.SH RETURN VALUE 22Returns 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN 23when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative 24number, it is not really a failure per se. 25.SH ERRORS 26\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. 27.SH AVAILABILITY 28Added in 1.4.0. 29 30Before 1.4.0 this function was known as libssh2_banner_set(3) 31.SH SEE ALSO 32.BR libssh2_session_handshake(3), 33.BR libssh2_session_banner_get(3)