IDictionary<TKey,TValue>.Remove(TKey) Method

Definition

Namespace:

System.Collections.Generic

Assembly:

System.Runtime.dll

Removes the element with the specified key from the IDictionary<TKey,TValue>.

public:
 bool Remove(TKey key);

public bool Remove (TKey key);

abstract member Remove : 'Key -> bool

Public Function Remove (key As TKey) As Boolean

Parameters

key

TKey

The key of the element to remove.

Returns

Boolean

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

Exceptions

ArgumentNullException

key is null.

NotSupportedException

The IDictionary<TKey,TValue> is read-only.

Examples

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<TKey,TValue>.

// 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.");
}

// 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.");
}

' Use the Remove method to remove a key/value pair.
Console.WriteLine(vbLf + "Remove(""doc"")")
openWith.Remove("doc")

If Not openWith.ContainsKey("doc") Then
    Console.WriteLine("Key ""doc"" is not found.")
End If

Remarks

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

See also

• IsReadOnly