IDictionary(Of TKey, TValue).Remove Method (TKey)
Removes the element with the specified key from the IDictionary(Of TKey, TValue).
Namespace: System.Collections.Generic
Assembly: mscorlib (in mscorlib.dll)
Parameters
- key
- Type: TKey
The key of the element to remove.
Return Value
Type: System.Booleantrue if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the original IDictionary(Of TKey, TValue).
| Exception | Condition |
|---|---|
| ArgumentNullException | key is Nothing. |
| NotSupportedException | The IDictionary(Of TKey, TValue) is read-only. |
Implementations can vary in how they determine equality of objects; for example, the List(Of T) class uses Comparer(Of T).Default, whereas the Dictionary(Of TKey, TValue) class allows the user to specify the IComparer(Of T) implementation to use for comparing keys.
The following code example shows how to remove a key/value pair from a dictionary using the Remove method.
This code is part of a larger example that can be compiled and executed. See System.Collections.Generic.IDictionary(Of TKey, TValue).
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.