99803822cb
- 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
1.4 KiB
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_channel_receive_window_adjust | 3 | libssh2 |
|
NAME
libssh2_channel_receive_window_adjust - adjust the channel window
SYNOPSIS
#include <libssh2.h>
unsigned long libssh2_channel_receive_window_adjust(LIBSSH2_CHANNEL * channel,
unsigned long adjustment,
unsigned char force);
DESCRIPTION
This function is DEPRECATED in 1.1.0. Use the libssh2_channel_receive_window_adjust2(3) function instead!
Adjust the receive window for a channel by adjustment bytes. If the amount to be adjusted is less than LIBSSH2_CHANNEL_MINADJUST and force is 0 the adjustment amount is queued for a later packet.
RETURN VALUE
Returns the new size of the receive window (as understood by remote end). Note that the window value sent over the wire is strictly 32-bit, but this API is made to return a 'long' which may not be 32-bit on all platforms.
ERRORS
In 1.0 and earlier, this function returns LIBSSH2_ERROR_EAGAIN for non-blocking channels where it would otherwise block. However, that is a negative number and this function only returns an unsigned value and this then leads to a strange value being returned.