XenoGuard Documentation

Get

Actions » Programming » List » Get 

The action Get retrieves a value from the list based on the specified indexed position and stores the result in Value of the result list.


[-] Hide
  1. Open the Programming node in the Workspace Explorer.
  2. In the List node, select the Get action.

Parameters:

The action 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]
Index
Specifies the index position of the value in the list.

Allowed Context Scopes
[Fixed, Local, Global]
Allowed Value [Unsigned Number]

Results:

The action returns the following results:


name
description
Value
Contains the value from the list after the index search.

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

Warning The Index parameter value should be within the range of the list. 

Example 1 (Displays the result of an index search from a list):

This example retrieves a value from an index search in the local list named Parts. The result is then stored in Value and is then output via Write Text.

See other list operations:

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