Syntax

PropertyObject.GetArrayOffset( lookupString, options, arrayIndex)

Return Value

Long

A zero-based number that represents the offset of an array element in the one-dimensional physical storage of the array.

Purpose

Returns the zero-based offset of the array element the arrayIndex parameter specifies.

Parameters

lookupString As String

[In] Pass an empty string to denote the PropertyObject to which the method applies, or pass the name of a subproperty within the PropertyObject. You can also pass lookup strings to this parameter.

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.

arrayIndex As String

[In] Specifies an array index string. Array index strings are a list of numbers, enclosed in brackets, that index each dimension of the array. For example, the following is an array index for a two-dimensional array: [0][1]. In addition, this method also supports indexing arrays of objects by name. For example, the following arrayIndex returns the offset of the first object in an object array with the name objectname: ["objectname"].

See Also

Lookup Strings

PropertyObject.GetArrayIndex

PropertyObject.GetNumElements

PropertyOptions

Thread Safety of the PropertyObject API and TestStand Variables