nsIDirectoryEnumerator

This interface provides a means for enumerating the contents of a directory. It is similar to nsISimpleEnumerator except the retrieved entries are QI'ed to nsIFile, and there is a mechanism for closing the directory when the enumeration is complete.
1.0
28
Introduced
Gecko 1.8
Inherits from: nsISupports Last changed in Gecko 1.8 (Firefox 1.5 / Thunderbird 1.5 / SeaMonkey 1.0)

Method overview

void close();

Attributes

Attribute Type Description
nextFile nsIFile The next file in the sequence. The nextFile attribute is the first element upon the first call. This attribute is null if there is no next element. Read only.

Methods

close()

Closes the directory being enumerated, releasing the system resource. It is safe to call this function many times.

void close();
Parameters

None.

Exceptions thrown
NS_OK
If the call succeeded and the directory was closed.
NS_ERROR_FAILURE
If the directory close failed.

Document Tags and Contributors

 Contributors to this page: Sheppy, fscholz, trevorh, Kglee
 Last updated by: Sheppy,