diff options
| author | Derrell Lipman <derrell@dworkin.(none)> | 2010-04-13 20:32:14 +0200 |
|---|---|---|
| committer | Karolin Seeger <kseeger@samba.org> | 2010-05-17 09:50:13 +0200 |
| commit | e0fccc374a3c209c6eea9a5bcb62ce84a3472cc1 (patch) | |
| tree | 7a14084b6e54f33a0312a51f51e55fb95a39f64c | |
| parent | 4d9210ef9cca057ddb2a6e648a0215996b3362f0 (diff) | |
| download | samba-e0fccc374a3c209c6eea9a5bcb62ce84a3472cc1.tar.gz | |
s3-libsmbclient: Fix incomplete description of function return values in libsmbclient.h.
Fix bug #7345.
(cherry picked from commit ce565b0498608714e2c4f7c9f9373dddcbfba568)
| -rw-r--r-- | source3/include/libsmbclient.h | 22 |
1 files changed, 14 insertions, 8 deletions
diff --git a/source3/include/libsmbclient.h b/source3/include/libsmbclient.h index dd6f93e261e..978f657e50d 100644 --- a/source3/include/libsmbclient.h +++ b/source3/include/libsmbclient.h @@ -1267,13 +1267,15 @@ int smbc_creat(const char *furl, mode_t mode); * * @param bufsize Size of buf in bytes * - * @return Number of bytes read, < 0 on error with errno set: + * @return Number of bytes read; + * 0 upon EOF; + * < 0 on error, with errno set: * - EISDIR fd refers to a directory * - EBADF fd is not a valid file descriptor or - * is not open for reading. + * is not open for reading. * - EINVAL fd is attached to an object which is - * unsuitable for reading, or no buffer passed or - * smbc_init not called. + * unsuitable for reading, or no buffer passed or + * smbc_init not called. * * @see smbc_open(), smbc_write() * @@ -1618,7 +1620,8 @@ int smbc_stat(const char *url, struct stat *st); * @param st pointer to a buffer that will be filled with * standard Unix struct stat information. * - * @return EBADF filedes is bad. + * @return 0 on success, < 0 on error with errno set: + * - EBADF filedes is bad. * - EACCES Permission denied. * - EBADF fd is not a valid file descriptor * - EINVAL Problems occurred in the underlying routines @@ -1639,7 +1642,8 @@ int smbc_fstat(int fd, struct stat *st); * @param st pointer to a buffer that will be filled with * standard Unix struct statvfs information. * - * @return EBADF filedes is bad. + * @return 0 on success, < 0 on error with errno set: + * - EBADF filedes is bad. * - EACCES Permission denied. * - EBADF fd is not a valid file descriptor * - EINVAL Problems occurred in the underlying routines @@ -1662,7 +1666,8 @@ smbc_statvfs(char *url, * @param st pointer to a buffer that will be filled with * standard Unix struct statvfs information. * - * @return EBADF filedes is bad. + * @return 0 on success, < 0 on error with errno set: + * - EBADF filedes is bad. * - EACCES Permission denied. * - EBADF fd is not a valid file descriptor * - EINVAL Problems occurred in the underlying routines @@ -1684,7 +1689,8 @@ smbc_fstatvfs(int fd, * * @param size size to truncate the file to * - * @return EBADF filedes is bad. + * @return 0 on success, < 0 on error with errno set: + * - EBADF filedes is bad. * - EACCES Permission denied. * - EBADF fd is not a valid file descriptor * - EINVAL Problems occurred in the underlying routines |