aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorAndreas Schneider <mail@cynapses.org>2009-04-24 09:33:47 +0000
committerAndreas Schneider <mail@cynapses.org>2009-04-24 09:33:47 +0000
commitac724eb3fb7ab2bf0554a497dd8d63633722ada8 (patch)
tree287197a18b900f3c93dc842230b28a2d52fdc8e8 /include
parent8ba57619fd247eebff3aea864f8bb7df5b83349a (diff)
downloadlibssh-ac724eb3fb7ab2bf0554a497dd8d63633722ada8.tar.gz
libssh-ac724eb3fb7ab2bf0554a497dd8d63633722ada8.tar.xz
libssh-ac724eb3fb7ab2bf0554a497dd8d63633722ada8.zip
Improve the sftp async read functions.
git-svn-id: svn+ssh://svn.berlios.de/svnroot/repos/libssh/trunk@602 7dcaeef0-15fb-0310-b436-a5af3365683c
Diffstat (limited to 'include')
-rw-r--r--include/libssh/sftp.h10
1 files changed, 5 insertions, 5 deletions
diff --git a/include/libssh/sftp.h b/include/libssh/sftp.h
index f7266bb3..37b45a90 100644
--- a/include/libssh/sftp.h
+++ b/include/libssh/sftp.h
@@ -377,7 +377,8 @@ ssize_t sftp_read(SFTP_FILE *file, void *buf, size_t count);
*
* @param len Size to read in bytes.
*
- * @return A u32 identifier corresponding to the sent request.
+ * @return An identifier corresponding to the sent request, < 0 on
+ * error.
*
* @warning When calling this function, the internal offset is
* updated corresponding to the len parameter.
@@ -391,7 +392,7 @@ ssize_t sftp_read(SFTP_FILE *file, void *buf, size_t count);
* @see sftp_async_read()
* @see sftp_open()
*/
-u32 sftp_async_read_begin(SFTP_FILE *file, u32 len);
+int sftp_async_read_begin(SFTP_FILE *file, u32 len);
/**
* @brief Wait for an asynchronous read to complete and save the data.
@@ -408,9 +409,8 @@ u32 sftp_async_read_begin(SFTP_FILE *file, u32 len);
* function.
*
* @return Number of bytes read, 0 on EOF, SSH_ERROR if an error
- * occured, SSH_AGAIN SSH_AGAIN if the file is opened in
- * nonblocking mode and the request hasn't been executed
- * yet.
+ * occured, SSH_AGAIN if the file is opened in nonblocking
+ * mode and the request hasn't been executed yet.
*
* @warning A call to this function with an invalid identifier
* will never return.