2007-06-13 13:50:34 +00:00
|
|
|
.\" $Id: libssh2_session_free.3,v 1.3 2007/06/13 13:50:34 jehousley Exp $
|
2006-12-21 14:09:12 +00:00
|
|
|
.\"
|
2007-06-13 13:50:34 +00:00
|
|
|
.TH libssh2_session_free 3 "1 June 2007" "libssh2 0.15" "libssh2 manual"
|
2006-12-21 14:09:12 +00:00
|
|
|
.SH NAME
|
|
|
|
|
libssh2_session_free - frees resources associated with a session instance
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
#include <libssh2.h>
|
|
|
|
|
|
2007-06-13 13:50:34 +00:00
|
|
|
int
|
|
|
|
|
libssh2_session_free(LIBSSH2_SESSION *session);
|
2006-12-21 14:09:12 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
|
Frees resources associated with a session instance. Typically called after
|
2007-06-13 13:50:34 +00:00
|
|
|
.BR libssh2_session_disconnect(3)
|
|
|
|
|
|
2006-12-21 14:09:12 +00:00
|
|
|
.SH RETURN VALUE
|
2007-06-13 13:50:34 +00:00
|
|
|
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.
|
2007-06-13 12:51:10 +00:00
|
|
|
.SH SEE ALSO
|
2007-06-13 13:50:34 +00:00
|
|
|
.BR libssh2_session_init(3)
|
|
|
|
|
.BR libssh2_session_disconnect(3)
|
