mirror of
https://github.com/libssh2/libssh2.git
synced 2025-10-30 12:05:34 +03:00
592e2b37fa
- simplify `.TH` headers. - delete empty lines before sections. - update template with an `AVAILABILITY` section. Left libssh2 version number in the `.TH` header for entries without an `AVAILABILITY` section, or where there was a different version number there.
25 lines
795 B
Groff
25 lines
795 B
Groff
.TH libssh2_session_banner_get 3 "9 Sep 2011" "libssh2" "libssh2"
|
|
.SH NAME
|
|
libssh2_session_banner_get - get the remote banner
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
|
|
const char *
|
|
libssh2_session_banner_get(oLIBSSH2_SESSION *session);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Once the session has been setup and \fIlibssh2_session_handshake(3)\fP has
|
|
completed successfully, this function can be used to get the server id from
|
|
the banner each server presents.
|
|
.SH RETURN VALUE
|
|
A pointer to a string or NULL if something failed. The data pointed to will be
|
|
allocated and associated to the session handle and will be freed by libssh2
|
|
when \fIlibssh2_session_free(3)\fP is used.
|
|
.SH AVAILABILITY
|
|
Added in 1.4.0
|
|
.SH SEE ALSO
|
|
.BR libssh2_session_banner_set(3),
|
|
.BR libssh2_session_handshake(3),
|
|
.BR libssh2_session_free(3)
|