Syntax

PropertyObject.GetArrayIndex( lookupString, options, arrayOffset)

Return Value

String

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] .

Purpose

Returns the index of the array element the arrayOffset parameter specifies.

Parameters

lookupString As String

[In] Specifies 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.

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.

See Also

Lookup Strings

PropertyObject.GetArrayOffset

PropertyObject.GetNumElements

PropertyObject.Type

PropertyOptions

Thread Safety of the PropertyObject API and TestStand Variables