MapKeyRemove

Removes a key-value pair from a WIL map.

Syntax:

MapKeyExist(map, key)

Parameters:

(m) map: a variable containing a WIL map.

(s) key: a string representing a key to remove from a WIL map.

Returns:

(m)  @True(1)if the key-value pair is removed and @False(0)if not removed.

The MapKeyRemove function deletes a key-value pair from a WIL map.

Note: The case of the key string is ignored.

Example:

Pairs = 'Apples,0':@tab:'Oranges,0':@tab:'Pears,0'
Fruit = MapCreate(Pairs)
; Remove oranges.
If MapKeyRemove(Fruit, 'Oranges')
   Text = 'Oranges removed from fruit collections.'
Else
   Text = 'Oranges must not have been in fruit collection.'
EndIf
Message('Oranges Removal', Text)

See Also:

MapCreate, MapFileGetCsv, MapFilePutCsv, MapKeyExist, MapKeysGet, MapKeyFind