Description |
Used to loop a block of steps through a range of numbers or loop a certain number of times The variable specified in the Index parameter is updated with the current loop count. With each successive loop a block of steps is executed and the loop counter is incremented by the number specified in the Step parameter. The loop ends after the counter has reached the number specified in the stop parameter or when a Break is encountered. |
Declaration |
<AMLOOP TOTALLOOPS="number" FROM="number"
TO="number" INDEX="text" STEP="number"> |
Examples |
<AMVARIABLE NAME="indexvar"></AMVARIABLE> |
General Tab Parameters |
Loop a number of times: Total Loops: Specifies the number of loops to be performed. Specifying TOTALLOOPS=5 is the same as specifying FROM=1 and TO=5. Click the Expression Builder icon to build and insert an expression. Number, Required (if FROM and
TO are not specified) Loop through a range: Starting index: Specifies the number to start counting from when determining the number of times to loop. This value will be reflected in the index value returned as well. Number, Required (if TOTALLOOPS
is not specified) Ending index: Specifies the number to count up to when determining the number of times to loop. Number, Required (if TOTALLOOPS
is not specified) |
Advanced Tab Parameters |
Increment by step: The number by which the index is incremented by when looping through the FROM= and TO= parameters. For example, if FROM=1 and TO=10 and STEP=2 then the action would loop 5 times, if STEP=1 then it would loop 10 times. Number, Optional - Default 1 Populate variable with index count: Specifies the name of a variable to populate with the current counter value. This number starts at FROM= and is incremented by STEP= each loop, until TO= is reached. Text, Optional |
See Also |
End Loop, Loop Files, Loop Windows, Loop Processes, Loop Expression, Loop Dataset, Loop List, Break |