Dictionary(Of TKey, TValue).Remove Method
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Removes the value with the specified key from the Dictionary(Of TKey, TValue).
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 found and removed; otherwise, false. This method returns false if key is not found in the Dictionary(Of TKey, TValue).
Implements
IDictionary(Of TKey, TValue).Remove(TKey)| Exception | Condition |
|---|---|
| ArgumentNullException | key is Nothing. |
If the Dictionary(Of TKey, TValue) does not contain an element with the specified key, the Dictionary(Of TKey, TValue) remains unchanged. No exception is thrown.
This method approaches an O(1) operation.
The following code example shows how to remove a key/value pair from a dictionary using the Remove method.
This code example is part of a larger example provided for the Dictionary(Of TKey, TValue) class.