1
0
mirror of https://github.com/libssh2/libssh2.git synced 2026-10-24 03:48:58 +03:00
Files
libssh2/docs/libssh2_poll_channel_read.md
Viktor Szakats 99803822cb tidy-up: miscellaneous
- fix typos in comments and documentation.
- fix references to non-existing functions in comments.
- libssh2_session_free: fix see-also reference on man page.
- libssh2_scp_recv2: fix typo in prototype on man page.
- man2help: use increment operator.
- badwords: extend with new words and an exclusion.
- userauth: unfold string.
- clang-format and manual formatting.

Closes #1988
2026-06-05 18:12:37 +02:00

816 B

c, SPDX-License-Identifier, Title, Section, Source, See-also
c SPDX-License-Identifier Title Section Source See-also
Copyright (C) The libssh2 project and its contributors. BSD-3-Clause libssh2_poll_channel_read 3 libssh2
libssh2_poll(3)

NAME

libssh2_poll_channel_read - check if data is available

SYNOPSIS

#include <libssh2.h>

int libssh2_poll_channel_read(LIBSSH2_CHANNEL *channel, int extended);

DESCRIPTION

This function is deprecated. Do not use.

libssh2_poll_channel_read(3) checks to see if data is available in the channel's read buffer. No attempt is made with this method to see if packets are available to be processed. For full polling support, use libssh2_poll(3).

AVAILABILITY

Marked as deprecated since 1.2.0

RETURN VALUE

Returns 1 if data is available, 0 if not, or a negative libssh2 error code on error.