1
0
mirror of https://github.com/libssh2/libssh2.git synced 2025-07-29 13:01:14 +03:00

libssh2_banner_set => libssh2_session_banner_get

Marked the old function as deprecated. Added the new name in the correct
name space with the same arguments and functionality.
This commit is contained in:
Daniel Stenberg
2011-09-09 23:11:42 +02:00
parent f2c21f6f84
commit 7229d989e7
6 changed files with 54 additions and 7 deletions

View File

@ -8,6 +8,9 @@ int
libssh2_banner_set(LIBSSH2_SESSION *session, const char *banner);
.SH DESCRIPTION
This function is \fbDEPRECATED\fP. Use \fIlibssh2_session_banner_set(3)\fP
instead!
\fIsession\fP - Session instance as returned by
.BR libssh2_session_init_ex(3)
@ -17,14 +20,13 @@ Set the banner that will be sent to the remote host when the SSH session is
started with
.BR libssh2_session_startup(3)
This is optional; a banner corresponding to the protocol and libssh2 version will be sent by default.
.SH 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 isn't really a failure per se.
.SH AVAILABILITY
Marked as deprecated since 1.4.0
.SH ERRORS
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
.SH SEE ALSO
.BR libssh2_session_startup(3)
.BR libssh2_session_handshake(3)