libssh2_channel_free - free all resources associated with a channel
#include <libssh2.h> int libssh2_channel_free(LIBSSH2_CHANNEL *channel);
libssh2 manual libssh2_channel_free(3ssh2)
NAME
libssh2_channel_free - free all resources associated with a channel
SYNOPSIS
#include <libssh2.h>
int libssh2_channel_free(LIBSSH2_CHANNEL *channel);
DESCRIPTION
channel - Channel stream to free.
Release all resources associated with a channel stream. If the channel
has not yet been closed with libssh2_channel_close(3) , it will be
called automatically so that the remote end may know that it can safely
free its own resources.
RETURN VALUE
Return 0 on success or negative on failure. It returns LIB-
SSH2_ERROR_EAGAIN when it would otherwise block. While LIB-
SSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per
se.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+------------------+
|Availability | library/libssh2 |
+---------------+------------------+
|Stability | Uncommitted |
+---------------+------------------+
SEE ALSO
libssh2_channel_close(3)
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from https://www.libssh2.org/download/lib-
ssh2-1.10.0.tar.gz.
Further information about this software can be found on the open source
community website at https://www.libssh2.org/.
libssh2 0.15 1 Jun 2007
libssh2_channel_free(3ssh2)