libssh2_session_banner_set - set the SSH protocol banner for the local client
Contents
Availability
Added in 1.4.0.
Before 1.4.0 this function was known as libssh2_banner_set(3)
Description
session - Session instance as returned by libssh2_session_init_ex(3)banner - A pointer to a zero-terminated string holding the user defined banner Set the banner that will be sent to the remote host when the SSH session is started with libssh2_session_handshake(3) This is optional; a banner corresponding to the protocol and libssh2 version will be sent by default.
Errors
LIBSSH2_ERROR_ALLOC - An internal memory allocation call failed.
Name
libssh2_session_banner_set - set the SSH protocol banner for the local client
Return Value
Returns 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise
block. While LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
See Also
libssh2_session_handshake(3),libssh2_session_banner_get(3) libssh2 9 Sep 2011 libssh2_session_banner_set(3)
Synopsis
#include <libssh2.h>
int
libssh2_session_banner_set(LIBSSH2_SESSION *session, const char *banner);
