nsILocalFile Interface

 This interface adds methods to nsIFile that are particular to a file
 that is accessible via the local file system.

 It follows the same string conventions as nsIFile.

 @status FROZEN

[scriptable, uuid(aa610f20-a889-11d3-8c81-000064657374)]

Constants

const unsigned long DELETE_ON_CLOSE = 2147483648

Attributes

readonly attribute PRInt64 diskSpaceAvailable

  followLinks

  This attribute will determine if the nsLocalFile will auto
  resolve symbolic links.  By default, this value will be false
  on all non unix systems.  On unix, this attribute is effectively
  a noop.

attribute PRBool followLinks

  Accessor to a null terminated string which will specify
  the file in a persistent manner for disk storage.

  The character set of this attribute is undefined.  DO NOT TRY TO
  INTERPRET IT AS HUMAN READABLE TEXT!

attribute ACString persistentDescriptor

Methods

[noscript] void appendRelativeNativePath(in ACString relativeFilePath)

  appendRelative[Native]Path

  Append a relative path to the current path of the nsILocalFile object.

   @param relativeFilePath
       relativeFilePath is a native relative path. For security reasons,
       this cannot contain .. or cannot start with a directory separator.
       For the |appendRelativeNativePath| method, the relativeFilePath 
       must be in the native filesystem charset.

void appendRelativePath(in AString relativeFilePath)

  getRelativeDescriptor

  Returns a relative file path in an opaque, XP format. It is therefore
  not a native path.

  The character set of the string returned from this function is
  undefined.  DO NOT TRY TO INTERPRET IT AS HUMAN READABLE TEXT!

   @param fromFile
       the file from which the descriptor is relative.
       There is no defined result if this param is null.

ACString getRelativeDescriptor(in nsILocalFile fromFile)

  initWithFile

  Initialize this object with another file

   @param aFile
       the file this becomes equivalent to

void initWithFile(in nsILocalFile aFile)

[noscript] void initWithNativePath(in ACString filePath)

  initWith[Native]Path

  This function will initialize the nsILocalFile object.  Any
  internal state information will be reset.  

  NOTE: This function has a known bug on the macintosh and
  other OSes which do not represent file locations as paths.
  If you do use this function, be very aware of this problem!

   @param filePath       
       A string which specifies a full file path to a 
       location.  Relative paths will be treated as an
       error (NS_ERROR_FILE_UNRECOGNIZED_PATH).  For 
       initWithNativePath, the filePath must be in the native
       filesystem charset.

void initWithPath(in AString filePath)

 
  launch

  Ask the operating system to attempt to open the file. 
  this really just simulates "double clicking" the file on your platform.
  This routine only works on platforms which support this functionality.

void launch()

 Return the result of PR_LoadLibrary on the file.  The caller is
 responsible for calling PR_UnloadLibrary on the result.

[noscript] PRLibraryStar load()

 Return the result of fopen on the file.  The caller is
 responsible for calling fclose on the result.

[noscript] FILE openANSIFileDesc(in string mode)

 Return the result of PR_Open on the file.  The caller is
 responsible for calling PR_Close on the result.

 @param flags the PR_Open flags from prio.h, plus optionally
 DELETE_ON_CLOSE. DELETE_ON_CLOSE may be implemented by removing
 the file (by path name) immediately after opening it, so beware
 of possible races; the file should be exclusively owned by this
 process.

[noscript] PRFileDescStar openNSPRFileDesc(in long flags, in long mode)

 
  reveal

  Ask the operating system to open the folder which contains
  this file or folder. This routine only works on platforms which 
  support the ability to open a folder...

void reveal()

  setRelativeDescriptor

  Initializes the file to the location relative to fromFile using
  a string returned by getRelativeDescriptor.

   @param fromFile
       the file to which the descriptor is relative
   @param relative
       the relative descriptor obtained from getRelativeDescriptor

void setRelativeDescriptor(in nsILocalFile fromFile, in ACString relativeDesc)