From 6c59eea5a9ea77127ec0fa3d6815c8adc743dba3 Mon Sep 17 00:00:00 2001 From: Miguel de Icaza Date: Tue, 16 Aug 2022 12:13:51 -0400 Subject: [PATCH] Document the obscure LIBSSH2_ERROR_BAD_USE when writing to a channel (#713) Document the obscure LIBSSH2_ERROR_BAD_USE when writing to a channel Credit: Miguel de Icaza --- docs/libssh2_channel_write_ex.3 | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/libssh2_channel_write_ex.3 b/docs/libssh2_channel_write_ex.3 index 4ef7df17..cb73648d 100644 --- a/docs/libssh2_channel_write_ex.3 +++ b/docs/libssh2_channel_write_ex.3 @@ -41,6 +41,11 @@ LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. \fILIBSSH2_ERROR_CHANNEL_CLOSED\fP - The channel has been closed. \fILIBSSH2_ERROR_CHANNEL_EOF_SENT\fP - The channel has been requested to be + +\fILIBSSH2_ERROR_BAD_USE\fP - This can be returned if you ignored a previous +return for LIBSSH2_ERROR_EAGAIN and rather than sending the original buffer with +the original size, you sent a new buffer with a different size. + closed. .SH SEE ALSO .BR libssh2_channel_open_ex(3)