1
0
mirror of https://github.com/libssh2/libssh2.git synced 2026-10-24 03:48:58 +03:00
Files
libssh2/docs/libssh2_banner_set.md
Viktor Szakats 9538c99fc4 badwords: add checker script, fix issues found
Checker script and wordlist comes from curl.

Also:
- checksrc.pl: sync up with curl.
- unfold an IETF URL.
- update all IETF URLs where missing.

Closes #1959
2026-06-01 13:22:40 +02:00

1.2 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_banner_set 3 libssh2
libssh2_session_handshake(3)
libssh2_session_init_ex(3)

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(3) function instead!

session - Session instance as returned by libssh2_session_init_ex(3)

banner - A pointer to a 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

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.