XenoGuard 4.0 Documentation
Remove
ActionStep Reference » Programming » Dictionary » Remove
The Dictionary Remove ActionStep removes the entry corresponding to a specified key from a dictionary and stores the deleted value in Value of the result list.
[-] Hide
- Open the Programming node in the Workspace Explorer.
- In the Dictionary node, select the Remove ActionStep.
Parameters:
The ActionStep has the following input parameters:
| NAME |
DESCRIPTION
|
|---|---|
| Dictionary |
The name of the dictionary where the key is to be searched.
Allowed Context Scopes [Local, Global] |
| Key |
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
|
|---|---|
| Key |
The key that was removed from the dictionary.
Allowed Context Scopes [Fixed, Local, Global] Allowed Context Types [Variable, Parameter] |
| Value |
The value that was removed from the dictionary.
Allowed Context Scopes [Fixed, Local, Global] Allowed Context Types [Variable, Parameter] |
Example 1 (Remove the first entry of a key-value pair in the dictionary):
This example removes the first occurrence of the specified key-value pair of the created local Position dictionary. The deleted Key and Value in the result list are then output via Message Box.
See other Dictionary operations:
Create
Add
Get
Get At
Count
Contains
Iterate
Remove At
Clear