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

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Removes the value with the specified key from the Dictionary<'TKey, 'TValue>.

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

abstract Remove : 
        key:'TKey -> bool
override 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 found and removed; otherwise, false. This method returns false if key is not found in the Dictionary<'TKey, 'TValue>.

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 (openWith is the name of the Dictionary used in this example).

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

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
Return to top
Show: