XenoGuard Documentation

Get

Actions » Programming » Dictionary » Get 

The action Get retrieves a value of the key-value pair from a dictionary based on the specified 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 action.

Parameters:

The action has the following input parameters:


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

Allowed Context Scopes
[Local, Global]
Key
Specifies the key of the key-value pair 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 key in a dictionary.

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

Warning A KeyNotFoundException error occurs when the Key parameter to be specified is not found among the key-value pairs of a dictionary. 

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

This example retrieves a value from a key search in the local dictionary named Employees. The result is then stored in Value in the result list and is then output via Message Box.

See other dictionary operations:

Create
Add
Get At
Count
Contains
Iterate
Remove
Remove At
Clear