From 06278728e23363638e6f321f2b141498792a8330 Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Sun, 30 Aug 2009 17:07:50 +0200 Subject: [PATCH] clarify that zero can be returned without meaning error --- docs/libssh2_channel_read_ex.3 | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/libssh2_channel_read_ex.3 b/docs/libssh2_channel_read_ex.3 index 4ecc6af..5e8117f 100644 --- a/docs/libssh2_channel_read_ex.3 +++ b/docs/libssh2_channel_read_ex.3 @@ -35,6 +35,9 @@ macros. Actual number of bytes read or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. + +Note that a return value of zero (0) can in fact be a legitimate value and +only signals that no payload data was read. It is not an error. .SH ERRORS \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.