mirror of
https://github.com/libssh2/libssh2.git
synced 2025-10-24 14:53:03 +03:00
b889b39945
To render in Git webviews as-is, to make it easier to edit, verify,
and to sync up with curl.
- add options to not build the `.3` man pages:
- autotools: `--disable-docs`
- cmake: `LIBSSH2_BUILD_DOCS=OFF`
- building `.3` man pages requires Perl after this patch.
- drop `mansyntax` and the shell / `grep` / GNU `man` tool requirements with it.
- scripts and most logic were copied from curl.
- add `cd2nroff` from curl, with edits to relax curl-specific checks.
- used `nroff2cd` (from curl) to convert from `.3` to `.md`. Then
manually fixed copyrights, inline function references and a couple
of other things.
Credits-to: Daniel Stenberg
Ref: eefcc1bda4
Ref: https://github.com/curl/curl/pull/12730
Ref: https://github.com/libssh2/www/issues/25#issuecomment-3289431671
Closes #1660
48 lines
1.1 KiB
Markdown
48 lines
1.1 KiB
Markdown
---
|
|
c: Copyright (C) The libssh2 project and its contributors.
|
|
SPDX-License-Identifier: BSD-3-Clause
|
|
Title: libssh2_channel_flush_ex
|
|
Section: 3
|
|
Source: libssh2
|
|
See-also:
|
|
---
|
|
|
|
# NAME
|
|
|
|
libssh2_channel_flush_ex - flush a channel
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_channel_flush_ex(LIBSSH2_CHANNEL *channel, int streamid);
|
|
|
|
int
|
|
libssh2_channel_flush(LIBSSH2_CHANNEL *channel);
|
|
|
|
int
|
|
libssh2_channel_flush_stderr(LIBSSH2_CHANNEL *channel);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
*channel* - Active channel stream to flush.
|
|
|
|
*streamid* - Specific substream number to flush. Groups of substreams may
|
|
be flushed by passing on of the following Constants.
|
|
|
|
**LIBSSH2_CHANNEL_FLUSH_EXTENDED_DATA**: Flush all extended data substreams
|
|
|
|
**LIBSSH2_CHANNEL_FLUSH_ALL**: Flush all substreams
|
|
|
|
Flush the read buffer for a given channel instance. Individual substreams may
|
|
be flushed by number or using one of the provided macros.
|
|
|
|
# RETURN VALUE
|
|
|
|
Return the number of bytes flushed 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.
|