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
   8 interface nsIFile;
   9
  10 /**
  11  * This interface provides a means for enumerating the contents of a directory.
  12  * It is similar to nsISimpleEnumerator except the retrieved entries are QI'ed
  13  * to nsIFile, and there is a mechanism for closing the directory when the
  14  * enumeration is complete.
  15  */
  16 [scriptable, uuid(31f7f4ae-6916-4f2d-a81e-926a4e3022ee)]
  17 interface nsIDirectoryEnumerator : nsISupports
  18 {
  19   /**
  20    * Retrieves the next file in the sequence. The "nextFile" element is the
  21    * first element upon the first call. This attribute is null if there is no
  22    * next element.
  23    */
  24   readonly attribute nsIFile nextFile;
  25
  26   /**
  27    * Closes the directory being enumerated, releasing the system resource.
  28    * @throws NS_OK if the call succeeded and the directory was closed.
  29    *         NS_ERROR_FAILURE if the directory close failed.
  30    *         It is safe to call this function many times.
  31    */
  32   void close();
  33 };
  34