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.
outputBlock.Text += "\nRemove(\"doc\")" + "\n";
openWith.Remove("doc");

if (!openWith.ContainsKey("doc"))
{
   outputBlock.Text += "Key \"doc\" is not found." + "\n";
}


Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Show:
© 2015 Microsoft