Interface nsIRelativeFilePrefType

The nsIRelativeFilePref interface is a wrapper for an nsIFile and and a directory service key. When used as a pref value, it stores a relative path to the file from the location pointed to by the directory service key. The path has the same syntax across all platforms.

See

  • nsIPrefBranch::getComplexValue
  • nsIPrefBranch::setComplexValue

Hierarchy

Properties

file relativeToKey

Methods

AddRef QueryInterface Release

Properties

file

file: nsIFile

file

The file whose location is stored or retrieved.

relativeToKey

relativeToKey: string

relativeToKey

A directory service key for the directory from which the file path is relative.

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

Settings

Member Visibility

Theme

Generated using TypeDoc