xpcom/io/nsIDirectoryEnumerator.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "nsISupports.idl"
   7 #include "nsISimpleEnumerator.idl"
   8
   9 interface nsIFile;
  10
  11 /**
  12  * This interface provides a means for enumerating the contents of a directory.
  13  * It is similar to nsISimpleEnumerator except the retrieved entries are QI'ed
  14  * to nsIFile, and there is a mechanism for closing the directory when the
  15  * enumeration is complete.
  16  */
  17 [scriptable, uuid(31f7f4ae-6916-4f2d-a81e-926a4e3022ee)]
  18 interface nsIDirectoryEnumerator : nsISimpleEnumerator
  19 {
  20   /**
  21    * Retrieves the next file in the sequence. The "nextFile" element is the
  22    * first element upon the first call. This attribute is null if there is no
  23    * next element.
  24    */
  25   readonly attribute nsIFile nextFile;
  26
  27   /**
  28    * Closes the directory being enumerated, releasing the system resource.
  29    * @throws NS_OK if the call succeeded and the directory was closed.
  30    *         NS_ERROR_FAILURE if the directory close failed.
  31    *         It is safe to call this function many times.
  32    */
  33   void close();
  34 };
  35