Interface nsIWritableVariantType

An object that implements nsIVariant may or may NOT also implement this nsIWritableVariant.

If the 'writable' attribute is false then attempts to call any of the 'set' methods can be expected to fail. Setting the 'writable' attribute may or may not succeed.

Hierarchy

nsIVariantType
- nsIWritableVariantType

Properties

`Readonly` dataType

dataType: uint16_t

writable

writable: boolean

Methods

AddRef

AddRef(): number
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

Inherited from nsIVariantType.AddRef

QueryInterface

QueryInterface(aIID: object, aInstancePtr?: object): any
Parameters
- aIID: object
- Optional aInstancePtr: object
Returns any

Inherited from nsIVariantType.QueryInterface
QueryInterface(aIID: object, aInstancePtr: object): void
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

Inherited from nsIVariantType.QueryInterface

Release

Release(): number
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

Inherited from nsIVariantType.Release

getAsACString

getAsACString(): string
Returns string

Inherited from nsIVariantType.getAsACString

getAsAString

getAsAString(): string
Returns string

Inherited from nsIVariantType.getAsAString

getAsAUTF8String

getAsAUTF8String(): string
Returns string

Inherited from nsIVariantType.getAsAUTF8String

getAsArray

getAsArray(type: uint16_t, iid: nsIID, count: uint32_t, ptr: voidPtr): number
Parameters
- type: uint16_t
- iid: nsIID
- count: uint32_t
- ptr: voidPtr
Returns number

Inherited from nsIVariantType.getAsArray

getAsBool

getAsBool(): boolean
Returns boolean

Inherited from nsIVariantType.getAsBool

getAsChar

getAsChar(): number
Returns number

Inherited from nsIVariantType.getAsChar

getAsDouble

getAsDouble(): number
Returns number

Inherited from nsIVariantType.getAsDouble

getAsFloat

getAsFloat(): number
Returns number

Inherited from nsIVariantType.getAsFloat

getAsID

getAsID(retval: nsID): number
Parameters
- retval: nsID
Returns number

Inherited from nsIVariantType.getAsID

getAsISupports

getAsISupports(): nsISupports
Returns nsISupports

Inherited from nsIVariantType.getAsISupports

getAsInt16

getAsInt16(): int16_t
Returns int16_t

Inherited from nsIVariantType.getAsInt16

getAsInt32

getAsInt32(): int32_t
Returns int32_t

Inherited from nsIVariantType.getAsInt32

getAsInt64

getAsInt64(): int64_t
Returns int64_t

Inherited from nsIVariantType.getAsInt64

getAsInt8

getAsInt8(): uint8_t
Returns uint8_t

Inherited from nsIVariantType.getAsInt8

getAsInterface

getAsInterface(iid: object, iface: object): void
Parameters
- iid: object
- iface: object
Returns void

Inherited from nsIVariantType.getAsInterface

getAsJSVal

getAsJSVal(): any
Returns any

Inherited from nsIVariantType.getAsJSVal

getAsString

getAsString(): string
Returns string

Inherited from nsIVariantType.getAsString

getAsStringWithSize

getAsStringWithSize(size: uint32_t, str: string): void
Parameters
- size: uint32_t
- str: string
Returns void

Inherited from nsIVariantType.getAsStringWithSize

getAsUint16

getAsUint16(): uint16_t
Returns uint16_t

Inherited from nsIVariantType.getAsUint16

getAsUint32

getAsUint32(): uint32_t
Returns uint32_t

Inherited from nsIVariantType.getAsUint32

getAsUint64

getAsUint64(): uint64_t
Returns uint64_t

Inherited from nsIVariantType.getAsUint64

getAsUint8

getAsUint8(): uint8_t
Returns uint8_t

Inherited from nsIVariantType.getAsUint8

getAsWChar

getAsWChar(): string
Returns string

Inherited from nsIVariantType.getAsWChar

getAsWString

getAsWString(): wstring
Returns wstring

Inherited from nsIVariantType.getAsWString

getAsWStringWithSize

getAsWStringWithSize(size: uint32_t, str: wstring): void
Parameters
- size: uint32_t
- str: wstring
Returns void

Inherited from nsIVariantType.getAsWStringWithSize

setAsACString

setAsACString(aValue: string): void
Parameters
- aValue: string
Returns void

setAsAString

setAsAString(aValue: string): void
Parameters
- aValue: string
Returns void

setAsAUTF8String

setAsAUTF8String(aValue: string): void
Parameters
- aValue: string
Returns void

setAsArray

setAsArray(type: uint16_t, iid: object, count: uint32_t, ptr: voidPtr): void
Parameters
- type: uint16_t
- iid: object
- count: uint32_t
- ptr: voidPtr
Returns void

setAsBool

setAsBool(aValue: boolean): void
Parameters
- aValue: boolean
Returns void

setAsChar

setAsChar(aValue: number): void
Parameters
- aValue: number
Returns void

setAsDouble

setAsDouble(aValue: number): void
Parameters
- aValue: number
Returns void

setAsEmpty

setAsEmpty(): void
Returns void

setAsEmptyArray

setAsEmptyArray(): void
Returns void

setAsFloat

setAsFloat(aValue: number): void
Parameters
- aValue: number
Returns void

setAsID

setAsID(aValue: object): void
Parameters
- aValue: object
Returns void

setAsISupports

setAsISupports(aValue: nsISupports): void
Parameters
- aValue: nsISupports
Returns void

setAsInt16

setAsInt16(aValue: int16_t): void
Parameters
- aValue: int16_t
Returns void

setAsInt32

setAsInt32(aValue: int32_t): void
Parameters
- aValue: int32_t
Returns void

setAsInt64

setAsInt64(aValue: int64_t): void
Parameters
- aValue: int64_t
Returns void

setAsInt8

setAsInt8(aValue: uint8_t): void
Parameters
- aValue: uint8_t
Returns void

setAsInterface

setAsInterface(iid: object, iface: object): void
Parameters
- iid: object
- iface: object
Returns void

setAsString

setAsString(aValue: string): void
Parameters
- aValue: string
Returns void

setAsStringWithSize

setAsStringWithSize(size: uint32_t, str: string): void
Parameters
- size: uint32_t
- str: string
Returns void

setAsUint16

setAsUint16(aValue: uint16_t): void
Parameters
- aValue: uint16_t
Returns void

setAsUint32

setAsUint32(aValue: uint32_t): void
Parameters
- aValue: uint32_t
Returns void

setAsUint64

setAsUint64(aValue: uint64_t): void
Parameters
- aValue: uint64_t
Returns void

setAsUint8

setAsUint8(aValue: uint8_t): void
Parameters
- aValue: uint8_t
Returns void

setAsVoid

setAsVoid(): void
Returns void

setAsWChar

setAsWChar(aValue: string): void
Parameters
- aValue: string
Returns void

setAsWString

setAsWString(aValue: wstring): void
Parameters
- aValue: wstring
Returns void

setAsWStringWithSize

setAsWStringWithSize(size: uint32_t, str: wstring): void
Parameters
- size: uint32_t
- str: wstring
Returns void

setFromVariant

setFromVariant(aValue: nsIVariant): void
Parameters
- aValue: nsIVariant
Returns void

Interface nsIWritableVariantType

Hierarchy

Index

Properties

Methods

Properties

Readonly dataType

writable

Methods

AddRef

Returns

Returns number

QueryInterface

Parameters

aIID: object

Optional aInstancePtr: object

Returns any

Returns

Parameters

aIID: object

aInstancePtr: object

Returns void

Release

Returns

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

`Readonly` dataType

`Optional` aInstancePtr: object