libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_channel_free 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
4
.SH NAME
5
libssh2_channel_free - free all resources associated with a channel
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9

10
int
11
libssh2_channel_free(LIBSSH2_CHANNEL *channel);
12
.fi
13
.SH DESCRIPTION
14
\fIchannel\fP - Channel stream to free.
15

16
Release all resources associated with a channel stream. If the channel has
17
not yet been closed with
18
.BR libssh2_channel_close(3)
19
, it will be called automatically so that the remote end may know that it
20
can safely free its own resources.
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 is not really a failure per se.
25
.SH SEE ALSO
26
.BR libssh2_channel_close(3)
27