XenoGuard 4.0 Documentation

Remove

ActionStep Reference » Programming » List » Remove

The ActionStep List Remove takes out the first occurrence of a specified value from a list and stores the deleted value in Removed of the result list.

[+] How to add the Remove ActionStep to the ActionScript:

[-] Hide

Open the Programming node in the Workspace Explorer.
In the List node, select the Remove ActionStep.

Parameters:

The ActionStep has the following input parameters:

NAME	DESCRIPTION
List	The name of the list where the value is to be searched. Allowed Context Scopes [Local, Global]
Value	The value to be removed from the list. Allowed Context Scopes [Fixed, Local, Global] Allowed Context Types [Variable, Parameter, Enum]

Results:

The ActionStep returns the following results:

NAME	DESCRIPTION
Removed	Contains the value that was removed from the list Allowed Context Scopes [Fixed, Local, Global] Allowed Context Types [Variable, Parameter]

Example 1 (Deletes a specified value from a list):

This example removes a specified value that is listed first within the created local Users list. The Iterate ActionStep was used to display the updated list after removing the specified value. The deleted value in Removed is then output via Write Text.

See other List operations:

Create
Add
Set At Index
Get
Contains
Count
Iterate
Remove At
Remove Match
Clear