IDictionary(Of TKey, TValue).Remove Method
Removes the element with the specified key from the IDictionary(Of TKey, TValue).
Assembly: mscorlib (in mscorlib.dll)
'Declaration Function Remove ( _ key As TKey _ ) As Boolean 'Usage Dim instance As IDictionary Dim key As TKey Dim returnValue As Boolean returnValue = instance.Remove(key)
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).
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.