XenoGuard Documentation

Get At

Actions » Programming » Dictionary » Get At 

The action Get At retrieves the value of the key-value pair from a dictionary based on the specified index position key and stores the result in Value of the result list.


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

Parameters:

The action has the following input parameters:


name Description
Dictionary The name of the dictionary where the index position key is to be retrieved.

Allowed Context Scopes [Local, Global]
Index
Specifies the index position key in the dictionary.

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 specified index position key in a dictionary.

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

Warning An exception error occurs when the specified index position key is out of range.

Example 1 (Displays the result of an index position key search from a dictionary):

This example gets a value from an index position key in the local dictionary named Employees. The result is then stored in Value of the result list and is then output via Message Box.

See other list operations:

Create
Add
Get
Count
Contains
Iterate
Remove
Remove At
Clear