Interface nsIPropertyBag2Type

Hierarchy

Properties

enumerator

Methods

AddRef QueryInterface Release get getProperty getPropertyAsACString getPropertyAsAString getPropertyAsAUTF8String getPropertyAsBool getPropertyAsDouble getPropertyAsInt32 getPropertyAsInt64 getPropertyAsInterface getPropertyAsUint32 getPropertyAsUint64 hasKey

Properties

Readonly enumerator

enumerator: nsISimpleEnumerator

Get a nsISimpleEnumerator whose elements are nsIProperty objects.

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

  • This method returns null if the value does not exist, or exists but is null.

    Parameters

    • prop: string

    Returns nsIVariant

getProperty

  • Get a property value for the given name.

    Throws

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

    Parameters

    • name: string

    Returns nsIVariant

getPropertyAsACString

  • Parameters

    • prop: string

    Returns string

getPropertyAsAString

  • Parameters

    • prop: string

    Returns string

getPropertyAsAUTF8String

  • Parameters

    • prop: string

    Returns string

getPropertyAsBool

  • Parameters

    • prop: string

    Returns boolean

getPropertyAsDouble

  • Parameters

    • prop: string

    Returns number

getPropertyAsInt32

  • Parameters

    • prop: string

    Returns int32_t

getPropertyAsInt64

  • Parameters

    • prop: string

    Returns int64_t

getPropertyAsInterface

  • This method returns null if the value exists, but is null.

    Note: C++ callers should not use this method. They should use the typesafe do_GetProperty wrapper instead.

    Parameters

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

    Returns void

getPropertyAsUint32

  • Parameters

    • prop: string

    Returns uint32_t

getPropertyAsUint64

  • Parameters

    • prop: string

    Returns uint64_t

hasKey

  • Check for the existence of a key.

    Parameters

    • prop: string

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc