1libssh2_session_banner_set(3) libssh2 manual 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 libssh2_session_banner_set(LIBSSH2_SESSION *session, const char
13 *banner);
14
15
17 session - Session instance as returned by libssh2_session_init_ex(3)
18
19 banner - A pointer to a zero-terminated string holding the user defined
20 banner
21
22 Set the banner that will be sent to the remote host when the SSH ses‐
23 sion is started with libssh2_session_handshake(3) This is optional; a
24 banner corresponding to the protocol and libssh2 version will be sent
25 by default.
26
28 Returns 0 on success or negative on failure. It returns LIB‐
29 SSH2_ERROR_EAGAIN when it would otherwise block. While LIB‐
30 SSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per
31 se.
32
34 LIBSSH2_ERROR_ALLOC - An internal memory allocation call failed.
35
37 Added in 1.4.0.
38
39 Before 1.4.0 this function was known as libssh2_banner_set(3)
40
42 libssh2_session_handshake(3), libssh2_session_banner_get(3)
43
44
45
46libssh2 1.4.0 9 Sep 2011 libssh2_session_banner_set(3)