nsIDirectoryServiceProvider

xpcom/io/nsIDirectoryService.idlScriptable

This interface is used by the Directory Service to get file locations.

Inherits from: nsISupports Last changed in Gecko 1.7

nsIDirectoryServiceProvider.

Method overview

nsIFile getFile(in string prop, out PRBool persistent);

Methods

getFile()

The Directory Service calls this method when it gets the first request for a prop or on every request if the prop is not persistent.

nsIFile getFile(
  in string prop,
  out PRBool persistent
);

Parameters

prop: The symbolic name of the file.
persistent: true if the returned file will be cached by Directory Service. Subsequent requests for this prop will bypass the provider and use the cache. false if the provider will be asked for this prop each time it is requested.

Return value

The nsIFile represented by the property.

Example

This code creates a global, read-only string called currDir with the value of the current working directory.

 __defineGetter__("currDir",
                  function getCurrDir() {
                    return Components.classes["@mozilla.org/file/directory_service;1"]
                                     .getService(Components.interfaces.nsIDirectoryServiceProvider)
                                     .getFile("CurWorkD",{}).path;
                   });

Test it with to see the magic happen.