Show TOC

Function documentationWhile Loop

 

This action is used to perform a specified set of actions until a condition is met or the maximum iterations count is reached. All actions in the sequence below the While Loop action are executed for each iteration.

Features

The properties for this action are listed in the following table:

Property

Data Type

Access

Use

CurrentItem

Integer

In and out

Returns the loop counter value for the iteration.

Break

Boolean

In and out

Stops the execution of the While Loop action. When the value is true, or 1, the loop stops.

MaxIterations

Integer

In and out

Sets the maximum number of iterations that the loop can perform before it stops. This action prevents a never- ending loop.

For example, if MaxIterations is set to 256, the While Loop action loops a maximum of 256 times.

Success

Boolean

In and out

Indicates whether the action succeeded or failed. If it failed, errors are displayed in the server trace log.