Name

libssh2_banner_set - set the SSH protocol banner for the local client

Synopsis

#include <libssh2.h>
 
int
libssh2_banner_set(LIBSSH2_SESSION *session, const char *banner);

Description

This function is DEPRECATED in 1.4.0. Use the libssh2_session_banner_set function instead!

session - Session instance as returned by libssh2_session_init_ex

banner - A pointer to a user defined banner

Set the banner that will be sent to the remote host when the SSH session is started with libssh2_session_handshake This is optional; a banner corresponding to the protocol and libssh2 version will be sent by default.

Return value

Return 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.

Availability

Marked as deprecated since 1.4.0

Errors

LIBSSH2_ERROR_ALLOC - An internal memory allocation call failed.

See also

libssh2_session_handshake

This HTML page was made with roffit.