Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Dictionary.Remove Method

Removes the value with the specified key from the Dictionary.

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

public bool Remove (
	TKey key
)
public final boolean Remove (
	TKey key
)
public final function Remove (
	key : TKey
) : boolean
Not applicable.

Parameters

key

The key of the element to remove.

Return Value

true if the element is successfully found and removed; otherwise, false. This method returns false if key is not found in the Dictionary.

Exception typeCondition

ArgumentNullException

key is a null reference (Nothing in Visual Basic).

If the Dictionary does not contain an element with the specified key, the Dictionary 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 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.");
}

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

.NET Compact Framework

Supported in: 2.0

XNA Framework

Supported in: 1.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft