WSDOT Custom Scripting: Dictionary.Remove Method

WSDOT Custom Scripting for Hyperion

Dictionary.Remove Method

Removes a key, item pair from a Dictionary object.

object.Remove (key)

Arguments

object: Required. Always the name of a Dictionary object.
key: Required. Key associated with the key, item pair you want to remove from the Dictionary object.

Remarks

An error occurs if the specified key, item pair does not exist.

The following example illustrates the use of the Remove method.

var a, d, i, s;              // Create some variables.
d = new wsdot_Dictionary();
d.Add ("a", "Athens");       // Add some keys and items.
d.Add ("b", "Belgrade");
d.Add ("c", "Cairo");
...
d.Remove("b");               // Remove second pair.

Applies To:

Dictionary Object

Requirements

The WSDOT Custom Scripts from the script repository must be loaded into the document.