libssh2/share/man/man3/libssh2_channel_free.3

   1 .\" $Id: libssh2_channel_free.3,v 1.1 2007/06/13 20:09:15 jehousley Exp $
   2 .\"
   3 .TH libssh2_channel_free 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_channel_free - free all resources associated with a channel
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8
   9 int
  10 libssh2_channel_free(LIBSSH2_CHANNEL *channel);
  11
  12 .SH DESCRIPTION
  13 \fIchannel\fP - Channel stream to free.
  14
  15 Release all resources associated with a channel stream. If the channel has
  16 not yet been closed with
  17 .BR libssh2_channel_close(3)
  18 , it will be called automatically so that the remote end may know that it
  19 can safely free its own resources.
  20
  21 .SH RETURN VALUE
  22 Return 0 on success or negative on failure.  It returns
  23 LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
  24 LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
  25
  26 .SH SEE ALSO
  27 .BR libssh2_channel_close(3)