Interface nsIPropertiesType

Simple mapping service interface.

Hierarchy

Methods

AddRef QueryInterface Release get has set 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

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

has

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

    Parameters

    • prop: string

    Returns boolean

set

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

    Parameters

    • prop: string
    • value: nsISupports

    Returns void

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