XenoGuard 4.0 Documentation
Remove At
ActionStep Reference » Programming » Dictionary » Remove At
The Dictionary Remove At ActionStep removes a key-value pair from a dictionary at a specified index position and stores the value in the Removed parameter of the result list.
[-] Hide
- Open the Programming node in the Workspace Explorer.
- In the Dictionary node, select the Remove At ActionStep.
Parameters:
The ActionStep 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 ActionStep 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] |
|
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.
