variant

Provides a general-purpose type that can hold values of any other type.

Summary
variantProvides a general-purpose type that can hold values of any other type.
Exceptions
TypeMismatchExceptionIndicates an attempt to read a value of the wrong type from a Variant.
Enumerations
TypeThe type of a variant value.
Types
VariantOpaque variant type.
Functions
makeNullMake a Variant with a null value.
makeBooleanMake a Variant with a boolean value.
makeNumberMake a Variant with a number value.
makeStringMake a Variant with a string value.
makeBytesMake a Variant with a bytes value.
makeArrayMake a Variant with an array value.
makeDictionaryMake a Variant with a dictionary value.
Variant.getTypeReturn the type of a variant.
Variant.isNullReturn TRUE if the variant is a null value.
Variant.getBooleanGet a boolean value from a Variant.
Variant.getNumberGet a number value from a Variant.
Variant.getStringGet a string value from a Variant.
Variant.getBytesGet a bytes value from a Variant.
Variant.getArrayGet an array value from a Variant.
Variant.getDictionaryGet a dictionary value from a Variant.
Variant.toStringReturn a string representation of a Variant value.

Exceptions

TypeMismatchException

Indicates an attempt to read a value of the wrong type from a Variant.

Enumerations

Type

The type of a variant value.

Values

nullnull value
booleanboolean
numbernumber
stringstring
bytesbytes
arrayarray
dictionarydictionary

Types

Variant

Opaque variant type.

Functions

makeNull

FUNCTION makeNull(): Variant

Make a Variant with a null value.

makeBoolean

FUNCTION makeBoolean(b: Boolean): Variant

Make a Variant with a boolean value.

makeNumber

FUNCTION makeNumber(n: Number): Variant

Make a Variant with a number value.

makeString

FUNCTION makeString(s: String): Variant

Make a Variant with a string value.

makeBytes

FUNCTION makeBytes(b: Bytes): Variant

Make a Variant with a bytes value.

makeArray

FUNCTION makeArray(a: Array<Variant>): Variant

Make a Variant with an array value.

makeDictionary

FUNCTION makeDictionary(d: Dictionary<Variant>): Variant

Make a Variant with a dictionary value.

Variant.getType

FUNCTION Variant.getType(IN self: Variant): Type

Return the type of a variant.

Variant.isNull

FUNCTION Variant.isNull(IN self: Variant): Boolean

Return TRUE if the variant is a null value.

Variant.getBoolean

FUNCTION Variant.getBoolean(IN self: Variant): Boolean

Get a boolean value from a Variant.

Variant.getNumber

FUNCTION Variant.getNumber(IN self: Variant): Number

Get a number value from a Variant.

Variant.getString

FUNCTION Variant.getString(IN self: Variant): String

Get a string value from a Variant.

Variant.getBytes

FUNCTION Variant.getBytes(IN self: Variant): Bytes

Get a bytes value from a Variant.

Variant.getArray

FUNCTION Variant.getArray(IN self: Variant): Array<Variant>

Get an array value from a Variant.

Variant.getDictionary

FUNCTION Variant.getDictionary(IN self: Variant): Dictionary<Variant>

Get a dictionary value from a Variant.

Variant.toString

FUNCTION Variant.toString(IN self: Variant): String

Return a string representation of a Variant value.

Opaque variant type.
FUNCTION makeNull(): Variant
Make a Variant with a null value.
FUNCTION makeBoolean(b: Boolean): Variant
Make a Variant with a boolean value.
FUNCTION makeNumber(n: Number): Variant
Make a Variant with a number value.
FUNCTION makeString(s: String): Variant
Make a Variant with a string value.
FUNCTION makeBytes(b: Bytes): Variant
Make a Variant with a bytes value.
FUNCTION makeArray(a: Array<Variant>): Variant
Make a Variant with an array value.
FUNCTION makeDictionary(d: Dictionary<Variant>): Variant
Make a Variant with a dictionary value.
FUNCTION Variant.getType(IN self: Variant): Type
Return the type of a variant.
FUNCTION Variant.isNull(IN self: Variant): Boolean
Return TRUE if the variant is a null value.
FUNCTION Variant.getBoolean(IN self: Variant): Boolean
Get a boolean value from a Variant.
FUNCTION Variant.getNumber(IN self: Variant): Number
Get a number value from a Variant.
FUNCTION Variant.getString(IN self: Variant): String
Get a string value from a Variant.
FUNCTION Variant.getBytes(IN self: Variant): Bytes
Get a bytes value from a Variant.
FUNCTION Variant.getArray(IN self: Variant): Array<Variant>
Get an array value from a Variant.
FUNCTION Variant.getDictionary(IN self: Variant): Dictionary<Variant>
Get a dictionary value from a Variant.
FUNCTION Variant.toString(IN self: Variant): String
Return a string representation of a Variant value.
Close