Syntax

Step.GetBreakSettings( isSet, enabled, passCount, Condition, [executionParam])

Purpose

Returns a value that indicates whether the step of a sequence is set to break.

Parameters

isSet As Boolean

[Out] Returns a value that indicates whether the breakpoint is set.

enabled As Boolean

[Out] Returns a value that indicates whether the breakpoint is enabled. TestStand ignores disabled breakpoints during execution.

passCount As Long

[Out] Returns the number of times the execution must evaluate the condition expression before suspending the execution. Pass 0 if you do not want to use a conditional pass count.

Condition As String

[Out] Returns the expression that must evaluate to True before suspending the execution. An empty value defaults to True . If you specify a non-zero pass count value and a condition expression for the breakpoint, the pass count only decrements when the expression evaluates to True .

executionParam As Variant

[In] [ Optional ] Specifies a reference to an Execution object to obtain the breakpoint settings on a step, which apply to a particular execution. If there is no execution-specific breakpoint setting or if you do not pass an Execution object, the method returns the breakpoint setting on the step of the sequence file.

See Also

Omitting Optional Parameters

Sequence.GetBreakOnEndSettings

Sequence.SetBreakOnEndSettings

Step.SetBreakSettings