Dictionary<TKey, TValue>.Remove Method
Removes the value with the specified key from the Dictionary<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 found and removed; otherwise, false. This method returns false if key is not found in the Dictionary<TKey, TValue>.
Implements
IDictionary<TKey, TValue>.Remove(TKey)| Exception | Condition |
|---|---|
| ArgumentNullException | key is null. |
If the Dictionary<TKey, TValue> does not contain an element with the specified key, the Dictionary<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<TKey, TValue> class.
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.