libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_banner_set 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
4
.SH NAME
5
libssh2_banner_set - set the SSH protocol banner for the local client
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9

10
int
11
libssh2_banner_set(LIBSSH2_SESSION *session, const char *banner);
12
.fi
13
.SH DESCRIPTION
14
This function is \fBDEPRECATED\fP in 1.4.0. Use the
15
\fIlibssh2_session_banner_set(3)\fP function instead!
16

17
\fIsession\fP - Session instance as returned by
18
.BR libssh2_session_init_ex(3)
19

20
\fIbanner\fP - A pointer to a user defined banner
21

22
Set the banner that will be sent to the remote host when the SSH session is
23
started with
24
.BR libssh2_session_handshake(3)
25
This is optional; a banner corresponding to the protocol and libssh2 version
26
will be sent by default.
27
.SH RETURN VALUE
28
Return 0 on success or negative on failure. It returns
29
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
30
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
31
.SH AVAILABILITY
32
Marked as deprecated since 1.4.0
33
.SH ERRORS
34
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
35
.SH SEE ALSO
36
.BR libssh2_session_handshake(3)
37