Name
dict_remove — Removes the given key and associated dependent value from the given dictionary.
Synopsis
int dict_remove ( |
inout dict dictionary , |
inout key any ); |
Description
The function removes the given key and the associated dependent value from the given dictionary. If the key-value pair is found (and removed) the function returns 1. If the dictionary does not contain a key equivalent to the given one the function returns zero.
Parameters
dict
Dictionary object to process.
key
Key of a key-value pair that should be removed from the dictionary.
Return Types
Integer flag indicating if a key-value pair has been found and removed.