Changeset 21462

Timestamp:

Feb 12, 2009, 4:49:00 PM (17 years ago)

Author:

jhoblitt

Message:

doc update

File:

• trunk/Nebulous/nebclient/src/nebclient.h (modified) (2 diffs)

trunk/Nebulous/nebclient/src/nebclient.h

@@ -4 +4 @@
  * Copyright (C) 2005  Joshua Hoblitt
  *
- * $Id: nebclient.h,v 1.39 2009-02-13 02:45:47 jhoblitt Exp $
+ * $Id: nebclient.h,v 1.40 2009-02-13 02:49:00 jhoblitt Exp $
  */
 
@@ -165 +165 @@
 );
 
-/** Get an Xattr on a storage object
- *
- * @return true on success
+/** List all Xattrs on a storage object
+ *
+ * This function returns the count of Xattrs on an object and the actual names
+ * are returned in the (char **) pointed to by the xattrs param.  The xattrs
+ * param may be NULL.
+ *
+ * @return int
  */
 int nebListXattr(
     nebServer *server,                  ///< nebServer object
     const char *key,                    ///< storage object key (name)
-    char ***xattrs                      ///< array of xattr names
+    char ***xattrs                      ///< array of xattr names to return
 );