Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIDirectoryEnumerator Interface Reference

This interface provides a means for enumerating the contents of a directory. More...

import "nsIDirectoryEnumerator.idl";

Inheritance diagram for nsIDirectoryEnumerator:
Inheritance graph
[legend]
Collaboration diagram for nsIDirectoryEnumerator:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void close ()
 Closes the directory being enumerated, releasing the system resource.

Public Attributes

readonly attribute nsIFile nextFile
 Retrieves the next file in the sequence.

Detailed Description

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.

UNDER_REVIEW

Definition at line 51 of file nsIDirectoryEnumerator.idl.


Member Function Documentation

Closes the directory being enumerated, releasing the system resource.

Exceptions:
NS_OKif the call succeeded and the directory was closed. NS_ERROR_FAILURE if the directory close failed. It is safe to call this function many times.

Member Data Documentation

Retrieves the next file in the sequence.

The "nextFile" element is the first element upon the first call. This attribute is null if there is no next element.

Definition at line 58 of file nsIDirectoryEnumerator.idl.


The documentation for this interface was generated from the following file: