libssh2_channel_free(3)

libssh2_channel_free3

Free all resources associated with a channel

Usage

#include <libssh2.h>
int
libssh2_channel_free(LIBSSH2_CHANNEL *channel);

Overview

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 LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.

Releases

10 releases since Debian 5.0 (Lenny); the text changed 2 times.

  1. 5.0–6.0
  2. 7–12
  3. 13–Arch

From libssh2 1.11.1-7 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.