* @return Valid file handle, < 0 on error with errno set:
* - ENOMEM Out of memory
* - EINVAL if an invalid parameter passed, like no
- * file.
+ * file, or smbc_init not called.
* - EEXIST pathname already exists and O_CREAT and
* O_EXCL were used.
* - EISDIR pathname refers to a directory and
* - ENOTDIR A file on the path is not a directory
* - ENOENT A directory component in pathname does
* not exist.
- * - EUCLEAN smbc_init() failed or has not been called
*
* @see smbc_creat()
*
* @return Valid file handle, < 0 on error with errno set:
* - ENOMEM Out of memory
* - EINVAL if an invalid parameter passed, like no
- * file.
+ * file, or smbc_init not called.
* - EEXIST pathname already exists and O_CREAT and
* O_EXCL were used.
* - EISDIR pathname refers to a directory and
* - ENOENT A directory component in pathname does
* not exist.
* - ENODEV The requested share does not exist.
- * - EUCLEAN smbc_init() failed or has not been called
* @see smbc_open()
*
*/
* - EBADF fd is not a valid file descriptor or
* is not open for reading.
* - EINVAL fd is attached to an object which is
- * unsuitable for reading, or no buffer passed.
- * - EUCLEAN smbc_init() failed or has not been called
+ * unsuitable for reading, or no buffer passed or
+ * smbc_init not called.
*
* @see smbc_open(), smbc_write()
*
* - EBADF fd is not a valid file descriptor or
* is not open for reading.
* - EINVAL fd is attached to an object which is
- * unsuitable for reading, or no buffer passed.
- * - EUCLEAN smbc_init() failed or has not been called
+ * unsuitable for reading, or no buffer passed or
+ * smbc_init not called.
+ *
* @see smbc_open(), smbc_read()
*
*/
* of (off_t)-1 is returned and errno is set to
* indicate the error:
* - EBADF Fildes is not an open file descriptor.
- * - EINVAL Whence is not a proper value.
- * - EUCLEAN smbc_init() failed or has not been called
+ * - EINVAL Whence is not a proper value or smbc_init
+ * not called.
*
* @todo Are all the whence values really supported?
*
*
* @return 0 on success, < 0 on error with errno set:
* - EBADF fd isn't a valid open file descriptor
- * - EUCLEAN smbc_init() failed or has not been called
+ * - EINVAL smbc_init() failed or has not been called
*
* @see smbc_open(), smbc_creat()
*/
* search (execute) permission
* - ENOENT A directory component in pathname does
* not exist
- * - EINVAL NULL was passed in the file param
+ * - EINVAL NULL was passed in the file param or
+ * smbc_init not called.
* - EACCES You do not have access to the file
* - ENOMEM Insufficient kernel memory was available
- * - EUCLEAN smbc_init() failed or has not been called
*
* @see smbc_rmdir()s
*
* i.e., contains entries other than "." and ".."
* - EINVAL The new url contained a path prefix
* of the old, or, more generally, an attempt was
- * made to make a directory a subdirectory of itself.
+ * made to make a directory a subdirectory of itself
+ * or smbc_init not called.
* - ENOTDIR A component used as a directory in ourl
* or nurl path is not, in fact, a directory. Or,
* ourl is a directory, and newpath exists but is not
* does not exist.
* - EXDEV Rename across shares not supported.
* - ENOMEM Insufficient kernel memory was available.
- * - EUCLEAN smbc_init() failed or has not been called
* - EEXIST The target file, nurl, already exists.
*
*
* @return Valid directory handle. < 0 on error with errno set:
* - EACCES Permission denied.
* - EINVAL A NULL file/URL was passed, or the URL would
- * not parse, or was of incorrect form.
+ * not parse, or was of incorrect form or smbc_init not
+ * called.
* - ENOENT durl does not exist, or name is an
* - ENOMEM Insufficient memory to complete the
* operation.
* - ENOTDIR name is not a directory.
* - EPERM the workgroup could not be found.
* - ENODEV the workgroup or server could not be found.
- * - EUCLEAN smbc_init() failed or has not been called
*
* @see smbc_getdents(), smbc_readdir(), smbc_closedir()
*
* total size. If there were no more dirents available,
* 0 is returned. < 0 indicates an error.
* - EBADF Invalid directory handle
- * - EINVAL Result buffer is too small
+ * - EINVAL Result buffer is too small or smbc_init
+ * not called.
* - ENOENT No such directory.
- * - EUCLEAN smbc_init() failed or has not been called
* @see , smbc_dirent, smbc_readdir(), smbc_open()
*
* @todo Are errno values complete and correct?
* @return A pointer to a smbc_dirent structure, or NULL if an
* error occurs or end-of-directory is reached:
* - EBADF Invalid directory handle
- * - EUCLEAN smbc_init() failed or has not been called
+ * - EINVAL smbc_init() failed or has not been called
*
* @see smbc_dirent, smbc_getdents(), smbc_open()
*/
* handle that allows the library to find the entry
* later.
* - EBADF dh is not a valid directory handle
- * - EUCLEAN smbc_init() failed or has not been called
+ * - EINVAL smbc_init() failed or has not been called
* - ENOTDIR if dh is not a directory
*
* @see smbc_readdir()
* NULL, in which case we will rewind
*
* @return 0 on success, -1 on failure
- * - EUCLEAN smbc_init() failed or has not been called
* - EBADF dh is not a valid directory handle
* - ENOTDIR if dh is not a directory
- * - EINVAL offset did not refer to a valid dirent
+ * - EINVAL offset did not refer to a valid dirent or
+ * smbc_init not called.
*
* @see smbc_telldir()
*
* permission to the process, or one of the directories
* - ENOENT A directory component in pathname does not
* exist.
- * - EINVAL NULL durl passed.
+ * - EINVAL NULL durl passed or smbc_init not called.
* - ENOMEM Insufficient memory was available.
- * - EUCLEAN smbc_init() failed or has not been called
*
* @see smbc_rmdir()
*
* @return 0 on success, < 0 on error with errno set:
* - EACCES or EPERM Write access to the directory
* containing pathname was not allowed.
- * - EINVAL durl is NULL.
+ * - EINVAL durl is NULL or smbc_init not called.
* - ENOENT A directory component in pathname does not
* exist.
* - ENOTEMPTY directory contains entries.
* - ENOMEM Insufficient kernel memory was available.
- * - EUCLEAN smbc_init() failed or has not been called
*
* @see smbc_mkdir(), smbc_unlink()
*
* @return 0 on success, < 0 on error with errno set:
* - ENOENT A component of the path file_name does not
* exist.
- * - EINVAL a NULL url was passed.
+ * - EINVAL a NULL url was passed or smbc_init not called.
* - EACCES Permission denied.
* - ENOMEM Out of memory
* - ENOTDIR The target dir, url, is not a directory.
- * - EUCLEAN smbc_init() failed or has not been called
*
* @see Unix stat()
*
* @return EBADF filedes is bad.
* - EACCES Permission denied.
* - EBADF fd is not a valid file descriptor
- * - EINVAL Problems occurred in the underlying routines.
+ * - EINVAL Problems occurred in the underlying routines
+ * or smbc_init not called.
* - ENOMEM Out of memory
- * - EUCLEAN smbc_init() failed or has not been called
*
* @see smbc_stat(), Unix stat()
*
*
* @return 0 on success, < 0 on error with errno set:
*
- * - EUCLEAN smbc_init() failed or has not been called
- * - EINVAL fname or printq was NULL
+ * - EINVAL fname or printq was NULL or smbc_init not
+ * not called.
* and errors returned by smbc_open
*
*/
*
* @returns A file handle for the print file if successful.
* Returns -1 if an error ocurred and errno has the values
- * - EUCLEAN smbc_init() failed or has not been called
- * - EINVAL fname was NULL
+ * - EINVAL fname was NULL or smbc_init not called.
* - all errors returned by smbc_open
*
*/
* @param fn Callback function the receives printjob info
*
* @return 0 on success, < 0 on error with errno set:
- * - EUCLEAN smbc_init() failed or has not been called
- * - EINVAL fname was NULL
+ * - EINVAL fname was NULL or smbc_init not called
* - EACCES ???
*/
int smbc_list_print_jobs(const char *purl, smbc_get_print_job_info fn);
* @param id The id of the job to delete
*
* @return 0 on success, < 0 on error with errno set:
- * - EUCLEAN smbc_init() failed or has not been called
- * - EINVAL fname was NULL
+ * - EINVAL fname was NULL or smbc_init not called
*
* @todo what errno values are possible here?
*/
git.samba.org / samba.git / commitdiff