summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRichard Sharpe <sharpe@samba.org>2001-03-10 01:29:20 +0000
committerRichard Sharpe <sharpe@samba.org>2001-03-10 01:29:20 +0000
commit9579f927dc5ce82bdf51ce49419dc039560e5e18 (patch)
treeec64e21852f23af4ff6b9b18da76994b80babf41
parent2a490ed2a07a3e60c9855f09bea455da705601c5 (diff)
downloadsamba-9579f927dc5ce82bdf51ce49419dc039560e5e18.tar.gz
samba-9579f927dc5ce82bdf51ce49419dc039560e5e18.tar.bz2
samba-9579f927dc5ce82bdf51ce49419dc039560e5e18.zip
More documentation in the header in doxygen format
(This used to be commit db2e712ad3ccfceb87d36e59d5f2e18a992b3e72)
-rw-r--r--source3/include/libsmbclient.h15
1 files changed, 12 insertions, 3 deletions
diff --git a/source3/include/libsmbclient.h b/source3/include/libsmbclient.h
index 2fe0af35e6..e1c8cf5c87 100644
--- a/source3/include/libsmbclient.h
+++ b/source3/include/libsmbclient.h
@@ -244,12 +244,20 @@ int smbc_init(smbc_get_auth_data_fn fn, int debug);
* the access requested involved writing.
* - EACCES The requested access to the file is not
* allowed
+ * - ENODEV The requested share does not exist
+ * - 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()
*
+ * @note This call uses an underlying routine that may create
+ * a new connection to the server specified in the URL.
+ * If the credentials supplied in the URL, or via the
+ * auth_fn in the smbc_init call, fail, this call will
+ * try again with an empty username and password. This
+ * often gets mapped to the guest account on some machines.
*/
int smbc_open(const char *furl, int flags, mode_t mode);
@@ -281,6 +289,7 @@ int smbc_open(const char *furl, int flags, mode_t mode);
* allowed
* - 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()
*
@@ -435,8 +444,8 @@ int smbc_unlink(const char *furl);
* - 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.
*
- * @todo Are errno values complete and correct?
*
* @todo Are we going to support copying when urls are not on the same
* share? I say no... NOTE. I agree for the moment.
@@ -633,6 +642,7 @@ int smbc_rmdir(const char *durl);
* - EINVAL a NULL url was passed.
* - 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()
@@ -652,13 +662,12 @@ int smbc_stat(const char *url, struct stat *st);
* @return EBADF filedes is bad.
* - EACCES Permission denied.
* - EBADF fd is not a valid file descriptor
- * - EINVAL ??? What is this for??? It is the wrong return
+ * - EINVAL Problems occurred in the underlying routines.
* - ENOMEM Out of memory
* - EUCLEAN smbc_init() failed or has not been called
*
* @see smbc_stat(), Unix stat()
*
- * @todo Fix the EINVAL return ... It is wrong
*/
int smbc_fstat(int fd, struct stat *st);