DisplayPreconditionBuilderDialog Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

Engine.DisplayPreconditionBuilderDialog ( dlgTitle, preconditionExpr, sequence, dlgOptions = 0, sequenceContext = NULL)

Return Value

Boolean

Returns True if you click OK in the dialog box. Returns False if you click Cancel.

Purpose

Launches the Preconditions dialog box, in which you construct the precondition expression of a step.

Parameters

dlgTitle As String

[In] Specifies the title of the dialog box. Pass an empty string to use the default title for the dialog box.

preconditionExpr As String

[In/Out] Specifies the initial precondition expression string for the dialog box. You can pass an empty string for this parameter. This string must be a localized expression.

sequence As Sequence

[In] Specifies the sequence the dialog box displays for building the precondition expression.

dlgOptions As Long

[In] Specify CommonDlgOption_NoOptions or CommonDlgOption_ModalToAppMainWind. By default, the dialog box is modal to the last active window of the calling thread, or if there is none, to the last active window from AppMainHwnd. Pass CommonDlgOption_ModalToAppMainWind if you want the dialog box to be modal with respect to the window handle of the AppMainHwnd property. Typically, you do not need to set this option.

This parameter has a default value of 0.

sequenceContext As SequenceContext

[In] Specifies the context to use for browsing expressions.

This parameter has a default value of NULL.


See Also

Preconditions dialog box

Sequence

SequenceContext

Step.Precondition

WAS THIS ARTICLE HELPFUL?

Not Helpful