xnu-6153.121.1.tar.gz

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

diff --git a/bsd/man/man2/getdirentriesattr.2 b/bsd/man/man2/getdirentriesattr.2
index 78a839766f1bc91b2a096c1a7c7ef6ea96bdc812..cc6c35ec70382917f525f36770030852979239ff 100644 (file)
--- a/bsd/man/man2/getdirentriesattr.2
+++ b/bsd/man/man2/getdirentriesattr.2
@@ -1,4 +1,4 @@
-.\" Copyright (c) 2003 Apple Computer, Inc. All rights reserved.
+q.\" Copyright (c) 2003 Apple Computer, Inc. All rights reserved.
 .\" 
 .\" The contents of this file constitute Original Code as defined in and
 .\" are subject to the Apple Public Source License Version 1.1 (the
@@ -20,7 +20,7 @@
 .Dt GETDIRENTRIESATTR 2
 .Os Darwin
 .Sh NAME
-.Nm getdirentriesattr
+.Nm getdirentriesattr(NOW DEPRECATED)
 .Nd get file system attributes for multiple directory entries
 .Sh SYNOPSIS
 .Fd #include <sys/attr.h>
@@ -207,7 +207,14 @@ It is typical to ask for a combination of common, file, and directory
 attributes and then use the value of the 
 .Dv ATTR_CMN_OBJTYPE 
 attribute to parse the resulting attribute buffer.
-.
+.Sh NOTES
+As of Mac OS X 10.10,
+.Fn getdirentriesattr
+is deprecated. It is replaced by
+.Nm getattrlistbulk(2).
+Continued use of
+.Fn getdirentriesattr
+is strongly discouraged as comprehensive results are not guaranteed.
 .Sh RETURN VALUES
 Upon successful completion a value of 0 or 1 is returned. 
 The value 0 indicates that the routine completed successfully. 
@@ -247,7 +254,7 @@ you should be careful to support the behaviour specified by this document.
 .
 .Pp
 If the directory contains a mount point, then
-.Dv DIR_MNTSTATUS_MNTPOINT
+.Dq DIR_MNTSTATUS_MNTPOINT
 will be set in the
 .Dv ATTR_DIR_MOUNTSTATUS
 for that entry; all other attributes for that entry, however,
@@ -255,6 +262,17 @@ will be for the underlying file system (as opposed to the mounted
 file system).
 .Xr getattrlist 2
 should be used to get the attributes for the mount point.
+.Pp
+A directory which is a firmlink will have the
+.Dq SF_FIRMLINK
+flag set in its
+ATTR_CMN_FLAGS attribute entry.
+However the attributes returned by
+.Fn getdirentriesattr
+will be those from the firmlink, not the firmlink's target.
+To get the attributes of the firmlink's target, call
+.Xr getattrlist 2
+on the firmlink.
 .Sh ERRORS
 .Fn getdirentriesattr
 will fail if: