Interface nsIVariantType

XPConnect has magic to transparently convert between nsIVariant and JS types. We mark the interface [scriptable] so that JS can use methods that refer to this interface. But we mark all the methods and attributes [noscript] since any nsIVariant object will be automatically converted to a JS type anyway.

Hierarchy

Properties

dataType

Methods

AddRef QueryInterface Release getAsACString getAsAString getAsAUTF8String getAsArray getAsBool getAsChar getAsDouble getAsFloat getAsID getAsISupports getAsInt16 getAsInt32 getAsInt64 getAsInt8 getAsInterface getAsJSVal getAsString getAsStringWithSize getAsUint16 getAsUint32 getAsUint64 getAsUint8 getAsWChar getAsWString getAsWStringWithSize

Properties

Readonly dataType

dataType: uint16_t

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

getAsACString

  • Returns string

getAsAString

  • Returns string

getAsAUTF8String

  • Returns string

getAsArray

  • Parameters

    • type: uint16_t
    • iid: nsIID
    • count: uint32_t
    • ptr: voidPtr

    Returns number

getAsBool

  • Returns boolean

getAsChar

  • Returns number

getAsDouble

  • Returns number

getAsFloat

  • Returns number

getAsID

  • Parameters

    • retval: nsID

    Returns number

getAsISupports

  • Returns nsISupports

getAsInt16

  • Returns int16_t

getAsInt32

  • Returns int32_t

getAsInt64

  • Returns int64_t

getAsInt8

  • Returns uint8_t

getAsInterface

  • Parameters

    • iid: object
    • iface: object

    Returns void

getAsJSVal

  • Returns any

getAsString

  • Returns string

getAsStringWithSize

  • Parameters

    • size: uint32_t
    • str: string

    Returns void

getAsUint16

  • Returns uint16_t

getAsUint32

  • Returns uint32_t

getAsUint64

  • Returns uint64_t

getAsUint8

  • Returns uint8_t

getAsWChar

  • Returns string

getAsWString

  • Returns wstring

getAsWStringWithSize

  • Parameters

    • size: uint32_t
    • str: wstring

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc