Export (0) Print
Expand All

IDictionary.Remove Method

Removes the element with the specified key from the IDictionary.

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

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

Parameters

key

The key of the element to remove.

Return Value

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

Exception typeCondition

ArgumentNullException

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

NotSupportedException

The IDictionary is read-only.

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

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.

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

Community Additions

ADD
Show:
© 2014 Microsoft