Syntax

PropertyObject.GetValStringByOffset( arrayOffset, options)

Return Value

String

String value of the array element.

Purpose

Returns the string value of the array element the arrayOffset parameter specifies.

Remarks

This method is valid only for array objects.

For numeric properties, calling this method with the PropOption_CoerceFromNumber option does not localize the resulting string. Use the PropertyObject.GetFormattedValue method to obtain a localized string for a number.

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 one or more PropertyOptions constants. Use the bitwise-OR operator to specify multiple options.

See Also

PropertyObject.GetFormattedValue

PropertyObject.GetValString

PropertyObject.SetValStringByOffset

PropertyOptions

Thread Safety of the PropertyObject API and TestStand Variables