1libssh2_session_banner_set(3) libssh2 libssh2_session_banner_set(3)
2
3
4
6 libssh2_session_banner_set - set the SSH protocol banner for the local
7 client
8
10 #include <libssh2.h>
11
12 int
13 libssh2_session_banner_set(LIBSSH2_SESSION *session, const char *banner);
14
16 session - Session instance as returned by libssh2_session_init_ex(3)
17
18 banner - A pointer to a zero-terminated string holding the user defined
19 banner
20
21 Set the banner that will be sent to the remote host when the SSH ses‐
22 sion is started with libssh2_session_handshake(3) This is optional; a
23 banner corresponding to the protocol and libssh2 version will be sent
24 by default.
25
27 Returns 0 on success or negative on failure. It returns LIBSSH2_ER‐
28 ROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is
29 a negative number, it is not really a failure per se.
30
32 LIBSSH2_ERROR_ALLOC - An internal memory allocation call failed.
33
35 Added in 1.4.0.
36
37 Before 1.4.0 this function was known as libssh2_banner_set(3)
38
40 libssh2_session_handshake(3), libssh2_session_banner_get(3)
41
42
43
44libssh2 9 Sep 2011 libssh2_session_banner_set(3)