Syntax

Sequence.GetBreakOnEndSettings( stepGroupParam, isSet, enabled, passCount, Condition, [executionParam])

Purpose

Returns a value that indicates whether the step group of the sequence is set to break when all the steps in the sequence execute.

Parameters

stepGroupParam As StepGroups

[In] Specifies a particular step group.

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 value for the passCount parameter and a condition expression for the breakpoint, the pass count decrements only when the expression evaluates to True .

executionParam As Variant

[In] [ Optional ] Pass a reference to an Execution object to obtain the breakpoint settings on the End 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 End step of the sequence file.

See Also

Omitting Optional Parameters

Sequence.SetBreakOnEndSettings

Step.GetBreakSettings

StepGroups