xnu-4903.270.47.tar.gz

[apple/xnu.git] / bsd / man / man2 / getattrlistbulk.2

diff --git a/bsd/man/man2/getattrlistbulk.2 b/bsd/man/man2/getattrlistbulk.2
index ee1b5a769fae1c02ed89baddcbd471b49b123a98..aaf91dd5aa93f137092fd9f2e916c313c4893f9a 100644 (file)
--- a/bsd/man/man2/getattrlistbulk.2
+++ b/bsd/man/man2/getattrlistbulk.2
@@ -39,6 +39,9 @@ each directory entry like
 Note: when
 .Fn getattrlistbulk
 returns information about a symbolic link, the information returned is about the link itself, not the target of the link.
+The order of the directory entries (and their associated metadata) vended by
+.Fn getattrlistbulk
+is not specified.  Some file systems may return entries in lexicographic sort order and others may not.
 .Pp
 The function reads directory entries from the directory referenced by the file
 descriptor 
@@ -84,7 +87,12 @@ Volume attributes  cannot be requested but all other supported getattrlist attri
 .Dv ATTR_CMN_NAME
 and
 .Dv ATRR_CMN_RETURNED_ATTRS
-are required and the absence of these attributes in the attrList parameter results in an error.
+are required and the absence of these attributes in the attrList parameter results in an error. Note that 
+not all attributes supported by 
+.Fn getattrlist
+may be vended back by this call, which is why the aforementioned flag must be supplied. In particular
+.Dv ATTR_CMN_FULLPATH
+may not be valid on all directory entries whose information is requested by this call. 
 .Pp
 .
 .\" attrBuf and attrBufSize parameters