IDictionary<'TKey, 'TValue>.Remove Method ('TKey)

.NET Framework (current version)

Removes the element with the specified key from the IDictionary<'TKey, 'TValue>.

Namespace: System.Collections.Generic
Assembly: mscorlib (in mscorlib.dll)

Syntax

abstract Remove : 
        key:'TKey -> bool

Parameters

key: Type: TKey
The key of the element to remove.

Return Value

Type: System.Boolean

true if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the original IDictionary<'TKey, 'TValue>.

Exceptions

Exception	Condition
ArgumentNullException	key is null.
NotSupportedException	The IDictionary<'TKey, 'TValue> is read-only.

Implementations can vary in how they determine equality of objects; for example, the List<'T> class uses Comparer<'T>.Default, whereas the Dictionary<'TKey, 'TValue> class allows the user to specify the IComparer<'T> implementation to use for comparing keys.

Examples

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<'TKey, 'TValue>.

C++

No code example is currently available or this language may not be supported.

Version Information

Universal Windows Platform
Available since 8
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1