niceSOFT/libssh2: the SSH library

docs/libssh2_session_free.3

20 строк665 B

Viktor Szakats

tidy-up: text nits, English contractions [ci skip]

27 апр 2023, 17:19

27 апр 2023, 17:19d67aaaf

.TH libssh2_session_free 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME
libssh2_session_free - frees resources associated with a session instance
.SH SYNOPSIS
.nf
#include <libssh2.h>

int
libssh2_session_free(LIBSSH2_SESSION *session);
.fi
.SH DESCRIPTION
Frees all resources associated with a session instance. Typically called after
.BR libssh2_session_disconnect_ex(3)
.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 is not really a failure per se.
.SH SEE ALSO
.BR libssh2_session_init_ex(3)
.BR libssh2_session_disconnect_ex(3)