Public Member Functions | Public Attributes

nsILocalFile Interface Reference

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

import "nsILocalFile.idl";

Inheritance diagram for nsILocalFile:
Collaboration diagram for nsILocalFile:

List of all members.

Public Member Functions

void initWithPath (in AString filePath)
 initWith[Native]Path
void initWithNativePath (in ACString filePath)
void initWithFile (in nsILocalFile aFile)
 initWithFile
PRFileDescStar openNSPRFileDesc (in long flags, in long mode)
 Return the result of PR_Open on the file.
FILE openANSIFileDesc (in string mode)
 Return the result of fopen on the file.
PRLibraryStar load ()
 Return the result of PR_LoadLibrary on the file.
void appendRelativePath (in AString relativeFilePath)
 appendRelative[Native]Path
void appendRelativeNativePath (in ACString relativeFilePath)
void reveal ()
 reveal
void launch ()
 launch
ACString getRelativeDescriptor (in nsILocalFile fromFile)
 getRelativeDescriptor
void setRelativeDescriptor (in nsILocalFile fromFile, in ACString relativeDesc)
 setRelativeDescriptor

Public Attributes

attribute PRBool followLinks
 followLinks
const unsigned long DELETE_ON_CLOSE = 0x80000000
readonly attribute PRInt64 diskSpaceAvailable
attribute ACString persistentDescriptor
 Accessor to a null terminated string which will specify the file in a persistent manner for disk storage.

Detailed Description

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

Member Function Documentation

void nsILocalFile::appendRelativeNativePath ( in ACString  relativeFilePath  ) 
void nsILocalFile::appendRelativePath ( in AString  relativeFilePath  ) 

appendRelative[Native]Path

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

Parameters:
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.
ACString nsILocalFile::getRelativeDescriptor ( in nsILocalFile  fromFile  ) 

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!

Parameters:
fromFile the file from which the descriptor is relative. There is no defined result if this param is null.
void nsILocalFile::initWithFile ( in nsILocalFile  aFile  ) 

initWithFile

Initialize this object with another file

Parameters:
aFile the file this becomes equivalent to
void nsILocalFile::initWithNativePath ( in ACString  filePath  ) 
void nsILocalFile::initWithPath ( in AString  filePath  ) 

initWith[Native]Path

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

Parameters:
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 nsILocalFile::launch (  ) 

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.

PRLibraryStar nsILocalFile::load (  ) 

Return the result of PR_LoadLibrary on the file.

The caller is responsible for calling PR_UnloadLibrary on the result.

FILE nsILocalFile::openANSIFileDesc ( in string  mode  ) 

Return the result of fopen on the file.

The caller is responsible for calling fclose on the result.

PRFileDescStar nsILocalFile::openNSPRFileDesc ( in long  flags,
in long  mode 
)

Return the result of PR_Open on the file.

The caller is responsible for calling PR_Close on the result.

Parameters:
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.
void nsILocalFile::reveal (  ) 

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 nsILocalFile::setRelativeDescriptor ( in nsILocalFile  fromFile,
in ACString  relativeDesc 
)

setRelativeDescriptor

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

Parameters:
fromFile the file to which the descriptor is relative
relative the relative descriptor obtained from getRelativeDescriptor

Member Data Documentation

const unsigned long nsILocalFile::DELETE_ON_CLOSE = 0x80000000

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.

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!


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