libssh2_banner_set.3 (1101B)
1.TH libssh2_banner_set 3 "1 Jun 2007" "libssh2 0.15" "libssh2" 2.SH NAME 3libssh2_banner_set - set the SSH protocol banner for the local client 4.SH SYNOPSIS 5.nf 6#include <libssh2.h> 7 8int 9libssh2_banner_set(LIBSSH2_SESSION *session, const char *banner); 10.fi 11.SH DESCRIPTION 12This function is \fBDEPRECATED\fP. Use \fIlibssh2_session_banner_set(3)\fP 13instead! 14 15\fIsession\fP - Session instance as returned by 16.BR libssh2_session_init_ex(3) 17 18\fIbanner\fP - A pointer to a user defined banner 19 20Set the banner that will be sent to the remote host when the SSH session is 21started with 22.BR libssh2_session_handshake(3) 23 This is optional; a banner corresponding to the protocol and libssh2 version will be sent by default. 24.SH RETURN VALUE 25Return 0 on success or negative on failure. It returns 26LIBSSH2_ERROR_EAGAIN when it would otherwise block. While 27LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. 28.SH AVAILABILITY 29Marked as deprecated since 1.4.0 30.SH ERRORS 31\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. 32.SH SEE ALSO 33.BR libssh2_session_handshake(3)