Break Action

Declaration

<AMBREAK>

See Also

Loop, End Loop, Loop Files, Loop Windows, Loop Processes, Loop Expression, Loop Dataset, Loop List

Description

Breaks out of a loop.

Practical Usage

Commonly used inside an IF <AMIF> action within a Loop <AMLOOP> to check for a condition and break out of the loop if the condition is true.

Parameters

General Tab

No parameters.

Notes

Custom Description

This action includes the Description tab for entering a custom step description.

More on setting custom step description

Standard Error Handling Options

This action also includes the standard Error Causes and On Error failure handling options/tabs.

More on Error Handling Options

Variables and Expressions

All text fields allow the use of expressions, which can be entered by surrounding the expression in percentage signs (example: %MYVARIABLE%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by pressing F2.

More on variables
More on expressions

More on the expression builder

Examples

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

<!--- Loop 6 times and test the value to see if it is greater than or equal to 3 each time, if it is then stop the loop using AMBREAK --->
<AMVARIABLE NAME="indexvar"></AMVARIABLE>
<AMLOOP TOTALLOOPS="6" RESULTVARIABLE="indexvar">
<AMMESSAGEBOX>%indexvar%</AMMESSAGEBOX>
<AMIF EXPRESSION="%indexvar% &gt;= 3">
   <AMBREAK>
</AMIF>
</AMLOOP>