Syntax

PropertyObject.GetValBoolean( lookupString, options)

Return Value

Boolean

Boolean value of the property.

Purpose

Returns the Boolean value of the property the lookupString 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.

Example

LabWindows/CVI:     VBOOL passFail;     TS_PropertyGetValBoolean(propObj, &errorInfo,                              "Step.Result.PassFail", 0, &passFail); Visual Basic (function call):     Dim passFail As Boolean     passFail = propObj.GetValBoolean("Step.Result.PassFail", 0) Visual Basic (inline):     Dim passFail As Boolean     passFail = propObj.Step.Result.PassFail Visual C++:     VARIANT_BOOL passFail;     passFail = propObj->GetValBoolean("Step.Result.PassFail", 0);

See Also

Lookup Strings

PropertyObject.GetValBooleanByOffset

PropertyObject.SetValBoolean

PropertyOptions

Thread Safety of the PropertyObject API and TestStand Variables