mirror of
https://github.com/libssh2/libssh2.git
synced 2025-11-03 22:13:11 +03:00
a3ffc4221d
- `- ` -> `- ` - `. ` -> `. ` - `\- ` -> `- ` - `-1` -> `\-1` - fold long lines along the way This makes the minus sign come out as a Unicode minus sign (0x2212), and title separator dashes as Unicode hyphen (0x2010), with `groff -Tutf8` v1.23.0. Ref: https://lwn.net/Articles/947941/ Closes #1210
27 lines
884 B
Groff
27 lines
884 B
Groff
.\" Copyright (C) The libssh2 project and its contributors.
|
|
.\" SPDX-License-Identifier: BSD-3-Clause
|
|
.TH libssh2_channel_free 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
|
|
.SH NAME
|
|
libssh2_channel_free - free all resources associated with a channel
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_channel_free(LIBSSH2_CHANNEL *channel);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
\fIchannel\fP - Channel stream to free.
|
|
|
|
Release all resources associated with a channel stream. If the channel has
|
|
not yet been closed with
|
|
.BR libssh2_channel_close(3)
|
|
, it will be called automatically so that the remote end may know that it
|
|
can safely free its own resources.
|
|
.SH RETURN VALUE
|
|
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 is not really a failure per se.
|
|
.SH SEE ALSO
|
|
.BR libssh2_channel_close(3)
|