XenoGuard Documentation

Remove At

Actions » Programming » Dictionary » Remove At 

The action Remove At takes out a key-value pair from a dictionary at the specified index position and stores the deleted key in Removed of the result list.


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

Parameters:

The action has the following input parameters:


NAME DESCRIPTION
Dictionary The name of the dictionary where the key is to be removed.

Allowed Context Scopes [Local, Global]
Index
The index position of the key to be removed from the dictionary.

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

Results:

The action returns the following results:


NAME
DESCRIPTION
Removed Contains the key that has been removed from the dictionary.

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

Warning An error occurs when the value of the Index parameter is out of range. 

Example 1 (Deletes a key at a specified index position in a dictionary):

This example removes the key based on the given index position in the created local Position dictionary. The deleted key in Removed is then output via Message Box.

See other dictionary operations:

Create
Add
Get
Get At
Count
Contains
Iterate
Remove
Clear