1.3 KiB
c, SPDX-License-Identifier, Title, Section, Source, See-also
| c | SPDX-License-Identifier | Title | Section | Source | See-also | |||
|---|---|---|---|---|---|---|---|---|
| Copyright (C) The libssh2 project and its contributors. | BSD-3-Clause | libssh2_session_banner_set | 3 | libssh2 |
|
NAME
libssh2_session_banner_set - set the SSH protocol banner for the local client
SYNOPSIS
#include <libssh2.h>
int libssh2_session_banner_set(LIBSSH2_SESSION *session, const char *banner);
DESCRIPTION
session - Session instance as returned by libssh2_session_init_ex(3)
banner - A pointer to a null-terminated string holding the user defined banner
Set the banner that is 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 is sent by default.
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.
ERRORS
LIBSSH2_ERROR_ALLOC - An internal memory allocation call failed.
LIBSSH2_ERROR_BAD_USE - If session is NULL.
LIBSSH2_ERROR_OUT_OF_BOUNDARY - If banner is oversized (> 4 MiB).
AVAILABILITY
Added in 1.4.0.
Before 1.4.0 this function was known as libssh2_banner_set(3)