PropertyObject.GetValNumberByOffset

Syntax

PropertyObject.GetValNumberByOffset( arrayOffset, options)

Return Value

Double

Double-precision, 64-bit floating-point value of the array element.

Purpose

Returns the double-precision, 64-bit floating-point value of the array element the arrayOffset parameter specifies.

Remarks

This method is valid only for array objects and is intended for use with arrays of double-precision, floating-point numbers. Use the PropertyObject.GetValInteger64ByOffset method with arrays of 64-bit integers, and use the PropertyObject.GetValUnsignedInteger64ByOffset method with arrays of unsigned 64-bit integers. If the array is of a type other than double-precision, floating-point, you can use this method with the corresponding PropOption_Coerce constant.

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

Lookup Strings

PropertyObject.GetValNumber

PropertyObject.GetValInteger64ByOffset

PropertyObject.GetValUnsignedInteger64ByOffset

PropertyObject.SetValNumberByOffset

PropertyOptions

Thread Safety of the PropertyObject API and TestStand Variables