XenoGuard Documentation

Return

Actions » Programming » Action Script » Return 

The action Return ends the execution of the current action script at the current position. If a parent script exists, the child script passes execution back to the parent script, otherwise all execution is stopped.



[-] Hide
  1. Open the Programming node in the Workspace Explorer.
  2. Open the Action Script node, select the Return action.

Parameters:

The action has the following input parameters:


name Description
State
Optionally sets the error status of the execution. If the status Failed is set, then the execution is marked as faulty and the status is passed up to the caller.

The following values are allowed: "Not Set" and "Failed"

Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types 
[Variable, Parameter, Result, Enum]

Results:

The action returns the following results:

NAME
DESCRIPTION
State
Contains the set error state.

Possible values: [Not Set, Failed].

Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter, Result]

Example 1 (Halts the running of an Action in an action script):

In this example, the master script runs a child script ReadFilesFromDirectory.xen that iterates the files located in a specified folder and aborts the loop sequence when the Max File Count reaches 100.

The master action script:


The child action script:


See other action script operations:

Start
Wait
Cancel
Write Error
Write Result
Append Result