libssh2/share/man/man3/libssh2_session_free.3

   1 .\" $Id: libssh2_session_free.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
   2 .\"
   3 .TH libssh2_session_free 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_session_free - frees resources associated with a session instance
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8
   9 int
  10 libssh2_session_free(LIBSSH2_SESSION *session);
  11 .SH DESCRIPTION
  12 Frees resources associated with a session instance. Typically called after
  13 .BR libssh2_session_disconnect(3)
  14
  15 .SH RETURN VALUE
  16 Return 0 on success or negative on failure.  It returns
  17 LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
  18 LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
  19 .SH SEE ALSO
  20 .BR libssh2_session_init(3)
  21 .BR libssh2_session_disconnect(3)