niceSOFT/libssh2: the SSH library

docs/libssh2_session_hostkey.3

24 строки687 B

Viktor Szakats

docs: simplify `.TH` header & other cleanups [ci skip]

26 апр 2023, 20:55

26 апр 2023, 20:55592e2b3

.TH libssh2_session_hostkey 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME
libssh2_session_hostkey - get the remote key
.SH SYNOPSIS
.nf
#include <libssh2.h>

const char *
libssh2_session_hostkey(LIBSSH2_SESSION *session,
                        size_t *len, int *type);
.fi
.SH DESCRIPTION
Returns a pointer to the current host key, the value \fIlen\fP points to will
get the length of the key.

The value \fItype\fP points to the type of hostkey which is one of:
LIBSSH2_HOSTKEY_TYPE_RSA, LIBSSH2_HOSTKEY_TYPE_DSS, or
LIBSSH2_HOSTKEY_TYPE_UNKNOWN.

.SH RETURN VALUE
A pointer, or NULL if something went wrong.
.SH SEE ALSO
.BR libssh2_knownhost_check(3)
.BR libssh2_knownhost_add(3)