summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDerrell Lipman <derrell@dworkin.(none)>2010-04-11 11:37:00 -0400
committerDerrell Lipman <derrell@dworkin.(none)>2010-04-11 11:37:00 -0400
commit0ee1985b05bd1a650f712a6d458b20c31eae8734 (patch)
tree2610d158d8dcfa61eb287d28aeddda7dc53ed268
parent59d68899c40ef368ab57fa734f95bcfb475bb46e (diff)
downloadsamba-0ee1985b05bd1a650f712a6d458b20c31eae8734.tar.gz
samba-0ee1985b05bd1a650f712a6d458b20c31eae8734.tar.bz2
samba-0ee1985b05bd1a650f712a6d458b20c31eae8734.zip
[Bug 7345] Incomplete description of function return values in libsmbclient.h
- Fixed documentation on smbc_fstat(), smbc_statvfs(), and smbc_fstatvfs(): All were missing return value upon success - Fixed documentation on smbc_read: Documented return value upon EOF Derrell
-rw-r--r--source3/include/libsmbclient.h22
1 files changed, 14 insertions, 8 deletions
diff --git a/source3/include/libsmbclient.h b/source3/include/libsmbclient.h
index dd6f93e261..978f657e50 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