Export (0) Print
Expand All

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)

public bool Remove(
	TKey key
)

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>.

Implements

IDictionary<TKey, TValue>.Remove(TKey)

ExceptionCondition
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.


// Use the Remove method to remove a key/value pair.
Console.WriteLine("\nRemove(\"doc\")");
openWith.Remove("doc");

if (!openWith.ContainsKey("doc"))
{
    Console.WriteLine("Key \"doc\" is not found.");
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2014 Microsoft