Interface nsIPersistentPropertiesType

Hierarchy

Methods

AddRef QueryInterface Release enumerate get getStringProperty has load save set setStringProperty sizeOfIncludingThis undefine

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

enumerate

  • get an enumeration of nsIPropertyElement objects, which are read-only (i.e. setting properties on the element will not make changes back into the source nsIPersistentProperties

    Returns nsISimpleEnumerator

get

  • Gets a property with a given name.

    Throws

    NS_ERROR_FAILURE if a property with that name doesn't exist.

    Throws

    NS_ERROR_NO_INTERFACE if the found property fails to QI to the given iid.

    Parameters

    • prop: string
    • iid: object
    • result: object

    Returns void

getStringProperty

  • shortcut to nsIProperty's get() which retrieves a string value directly (and thus faster)

    Parameters

    • key: string

    Returns string

has

  • Returns true if the property with the given name exists.

    Parameters

    • prop: string

    Returns boolean

load

  • load a set of name/value pairs from the input stream names and values should be in UTF8

    Parameters

    • input: nsIInputStream

    Returns void

save

  • output the values to the stream - results will be in UTF8

    Parameters

    • output: nsIOutputStream
    • header: string

    Returns void

set

  • Sets a property with a given name to a given value.

    Parameters

    • prop: string
    • value: nsISupports

    Returns void

setStringProperty

  • shortcut to nsIProperty's set() which sets a string value directly (and thus faster). If the given property already exists, then the old value will be returned

    Parameters

    • key: string
    • value: string

    Returns string

sizeOfIncludingThis

  • Parameters

    • aMallocSizeOf: MallocSizeOf

    Returns number

undefine

  • Undefines a property.

    Throws

    NS_ERROR_FAILURE if a property with that name doesn't already exist.

    Parameters

    • prop: string

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc