sin/samba-mirror
1
0
Fork 0
mirror of https://github.com/samba-team/samba.git synced 2024-12-23 17:34:34 +03:00
Code

[Bug 7345] Incomplete description of function return values in libsmbclient.h

Browse Source 
- 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
This commit is contained in:
Derrell Lipman 2010-04-11 11:37:00 -04:00
parent 59d68899c4
commit 0ee1985b05
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
source3/include/libsmbclient.h
View File

@ -1267,13 +1267,15 @@ int smbc_creat(const char *furl, mode_t mode);
* *
* @param bufsize Size of buf in bytes * @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 * - EISDIR fd refers to a directory
* - EBADF fd is not a valid file descriptor or * - 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 * - EINVAL fd is attached to an object which is
* unsuitable for reading, or no buffer passed or * unsuitable for reading, or no buffer passed or
* smbc_init not called. * smbc_init not called.
* *
* @see smbc_open(), smbc_write() * @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 * @param st pointer to a buffer that will be filled with
* standard Unix struct stat information. * 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. * - EACCES Permission denied.
* - EBADF fd is not a valid file descriptor * - EBADF fd is not a valid file descriptor
* - EINVAL Problems occurred in the underlying routines * - 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 * @param st pointer to a buffer that will be filled with
* standard Unix struct statvfs information. * 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. * - EACCES Permission denied.
* - EBADF fd is not a valid file descriptor * - EBADF fd is not a valid file descriptor
* - EINVAL Problems occurred in the underlying routines * - 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 * @param st pointer to a buffer that will be filled with
* standard Unix struct statvfs information. * 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. * - EACCES Permission denied.
* - EBADF fd is not a valid file descriptor * - EBADF fd is not a valid file descriptor
* - EINVAL Problems occurred in the underlying routines * - EINVAL Problems occurred in the underlying routines
@ -1684,7 +1689,8 @@ smbc_fstatvfs(int fd,
* *
* @param size size to truncate the file to * @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. * - EACCES Permission denied.
* - EBADF fd is not a valid file descriptor * - EBADF fd is not a valid file descriptor
* - EINVAL Problems occurred in the underlying routines * - EINVAL Problems occurred in the underlying routines