Returns a directory enumerator object that can be used to perform a deep enumeration of the directory at the specified URL.
- iOS 4.0+
- macOS 10.6+
- tvOS 9.0+
- watchOS 2.0+
The location of the directory for which you want an enumeration. This URL must not be a symbolic link that points to the desired directory. You can use the
URLBymethod to resolve any symlinks in the URL.
Resolving Symlinks In Path
An array of keys that identify the properties that you want pre-fetched for each item in the enumeration. The values for these keys are cached in the corresponding
NSURLobjects. You may specify
nilfor this parameter. For a list of keys you can specify, see
Options for the enumeration. For a list of valid options, see
An optional error handler block for the file manager to call when an error occurs. The handler block should return
YESif you want the enumeration to continue or
NOif you want the enumeration to stop. The block takes the following parameters:
NSURLobject that identifies the item for which the error occurred.
NSErrorobject that contains information about the error.
If you specify
nilfor this parameter, the enumerator object continues to enumerator items as if you had specified a block that returned
NSDirectory object that enumerates the contents of the directory at
url is a filename, the method returns an enumerator object that enumerates no files—the first call to
Because the enumeration is deep—that is, it lists the contents of all subdirectories—this enumerator object is useful for performing actions that involve large file-system subtrees. If the method is passed a directory on which another file system is mounted (a mount point), it traverses the mount point. This method does not resolve symbolic links or mount points encountered in the enumeration process, nor does it recurse through them if they point to a directory.
For example, if you pass a URL that points to
/Volumes/My, the returned enumerator will include the entire directory structure for the file system mounted at that location. If, on the other hand, you pass
/Volumes, the returned enumerator will include
/Volumes/My as one of its results, but will not traverse into the file system mounted there.
NSDirectory class has methods for skipping descendants of the existing path and for returning the number of levels deep the current object is in the directory hierarchy being enumerated (where the directory passed to
enumerator is considered to be level 0).
This code fragment enumerates a URL and its subdirectories, collecting the URLs of files (skips directories). It also demonstrates how to ignore the contents of specified directories, in this case directories named “_extras”.