PropertyObject.GetValVariantByOffset

Syntax

PropertyObject.GetValVariantByOffset( arrayOffset, options)

Return Value

Variant

Variant that contains the value of the array element. If the element is an empty array, this method returns a variant that contains an array with the bounds set to indicate that it contains no elements, such as [0..-1] .

Purpose

Returns the value of the array element the arrayOffset parameter specifies in a variant.

Remarks

This method is valid only for array objects.

Parameters

arrayOffset As Long

[In] Specifies a zero-based number representing the offset of an array element in the one-dimensional physical storage of the array. The offset is in terms of the number of elements.

options As Long

[In] Pass 0 to specify the default behavior, or pass one or more PropertyOptions constants. Use the bitwise-OR operator to specify multiple options.

See Also

PropertyObject.GetValVariant

PropertyObject.SetValVariantByOffset

PropertyOptions

Thread Safety of the PropertyObject API and TestStand Variables