Public Member Functions | Public Attributes

nsILocalFileWin Interface Reference

import "nsILocalFileWin.idl";

Inheritance diagram for nsILocalFileWin:
Collaboration diagram for nsILocalFileWin:

List of all members.

Public Member Functions

AString getVersionInfoField (in string aField)
 getVersionInfoValue

Public Attributes

readonly attribute AString canonicalPath
 The canonical path of the file, which avoids short/long pathname inconsistencies.
readonly attribute ACString nativeCanonicalPath
const unsigned long WFA_SEARCH_INDEXED = 1
 Windows specific file attributes.
attribute unsigned long fileAttributesWin
 fileAttributesWin

Member Function Documentation

AString nsILocalFileWin::getVersionInfoField ( in string  aField  ) 

getVersionInfoValue

Retrieve a metadata field from the file's VERSIONINFO block. Throws NS_ERROR_FAILURE if no value is found, or the value is empty.

Parameters:
aField The field to look up.

Member Data Documentation

readonly attribute AString nsILocalFileWin::canonicalPath

The canonical path of the file, which avoids short/long pathname inconsistencies.

The nsILocalFile persistent descriptor is not guaranteed to be canonicalized (it may persist either the long or the short path name). The format of the canonical path will vary with the underlying file system: it will typically be the short pathname on filesystems that support both short and long path forms.

attribute unsigned long nsILocalFileWin::fileAttributesWin

fileAttributesWin

Set or get windows specific file attributes.

Throws NS_ERROR_FILE_INVALID_PATH for an invalid file. Throws NS_ERROR_FAILURE if the set or get fails.

readonly attribute ACString nsILocalFileWin::nativeCanonicalPath
const unsigned long nsILocalFileWin::WFA_SEARCH_INDEXED = 1

Windows specific file attributes.

WFA_SEARCH_INDEXED: Generally the default on files in Windows except those created in temp locations. Valid on XP and up. When set the file or directory is marked to be indexed by desktop search services.


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