Break Action Icon

Break

Declaration

<AMBREAK />

See Also

Loop | End Loop | Loop Files | Loop Windows | Loop Processes | Loop Expression | Loop Dataset | Loop List | Loop List Control | Loop Processes | Loop Tree Control | Loop Windows | Break

Description

Breaks out of a Loop or If statement.

Practical Usage

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

Parameters

General Properties

There are no general parameters for this action.

Description Properties

The Description tab allows you to customize the text description of any step as it appears in the Task Builder's Steps Pane.

More on setting custom step description

Error Causes Properties

The Error Causes tab properties lets you instruct a task step to react only to specific errors or ignore certain errors that should cause it to fail.

More on Error Causes properties

On Error Properties

The On Error tab properties lets you determine what the task should do if a particular step encounters an error as defined in the Error Causes properties.

More about On Error properties

Additional Notes

Expressions, Variables & Functions

A percent sign is used as a special character in AutoMate to indicate the beginning and end of an expression. This allows variables, functions and other expressions to be entered in any text parameter of a task's properties. For example: %1+1% inside a task will resolve to 2 at runtime. A more elaborate example is %FileDateTime(myFile)% which results to the date/time of myFile. To help construct expressions, you can open Expression Builder by clicking the Insert Expression (%) button or by pressing F2.

More on expressions

More on variables

More on functions

More on extended functions
More on the expression builder

Example

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

 

Description: This sample task loops 6 times and examines the current value to see if it is greater than or equal to 3 during each iteration. If the value is greater than or equal to 3, the task breaks out of the loop using the Break action.

 

<AMVARIABLE NAME="indexvar"></AMVARIABLE>

<AMLOOP TOTALLOOPS="6" RESULTVARIABLE="indexvar">

     <AMSHOWDIALOG>%indexvar%</AMSHOWDIALOG>

     <AMIF EXPRESSION="%indexvar% &gt;= 3">

          <AMBREAK />

     </AMIF>

</AMLOOP>

 

↑ Top of Page