PropertyObject.GetValNumber

Syntax

PropertyObject.GetValNumber( lookupString, options)

Return Value

Double

Numeric value of the property.

Purpose

Returns the double-precision, 64-bit floating-point value of the property the lookupString parameter specifies.

Remarks

TestStand stores numeric values as double-precision, 64-bit floating-point values, signed 64-bit integer values, or unsigned 64-bit integer values.

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.

Example

LabWindows/CVI:     double highLimit;     TS_PropertyGetValNumber(propObj, &errorInfo, "Step.Limits.High",                             0, &highLimit); Visual Basic (function call):     Dim highLimit As Double         highLimit = propObj.GetValNumber("Step.Limits.High", 0) Visual Basic (inline):     Dim highLimit As Double     highLimit = propObj.Step.Limits.High Visual C++:     double highLimit;     highLimit = propObj->GetValNumber("Step.Limits.High", 0);

See Also

Lookup Strings

PropertyObject.GetValNumberByOffset

PropertyObject.SetValNumber

PropertyOptions

Thread Safety of the PropertyObject API and TestStand Variables