XenoGuard Documentation

Remove

Actions » Programming » Dictionary » Remove 

The action Remove takes out the first entry of a specified key from a dictionary and stores the deleted value in Key of the result list.


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

Parameters:

The action 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 action 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