libssh2
1.\" Copyright (C) The libssh2 project and its contributors.
2.\" SPDX-License-Identifier: BSD-3-Clause
3.TH libssh2_session_free 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
4.SH NAME
5libssh2_session_free - frees resources associated with a session instance
6.SH SYNOPSIS
7.nf
8#include <libssh2.h>
9
10int
11libssh2_session_free(LIBSSH2_SESSION *session);
12.fi
13.SH DESCRIPTION
14Frees all resources associated with a session instance. Typically called after
15.BR libssh2_session_disconnect_ex(3)
16.SH RETURN VALUE
17Return 0 on success or negative on failure. It returns
18LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
19LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
20.SH SEE ALSO
21.BR libssh2_session_init_ex(3)
22.BR libssh2_session_disconnect_ex(3)
23