remove from map(key a, name of map b)


Removes the key-value-pair with key a from a named map with name b. If no name is specified default will be used.

The return value is the value behind the key being removed. If the map is an inherited value, only the visible value will be returned.

Note: 'Hidden' values can be removed as well. See the explanations for the Empty Flag.

Description of Parameters

Parameter

Description

a

Key name to be removed.

b

(optional) Name of the map. Default: default

Examples

Defined is a map MyMap with the elements {key1=val1, key2=val2, key3=val3}.

Parameter a

Parameter b

Result

Elements in Map

MyMap

key2

val2

{key1=val1, key3=val3}

MyMap

key2

{key1=val1, key3=val3}

MyMap

key1

val1

{key3=val3}