IDictionary(Of TKey, TValue).Remove Method (TKey)


Removes the element with the specified key from the IDictionary(Of TKey, TValue).

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

Function Remove (
	key As TKey
) As Boolean


Type: TKey

The key of the element to remove.

Return Value

Type: System.Boolean

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

Implementations can vary in how they determine equality of objects; for example, the List(Of T) class uses Comparer(Of T).Default, whereas the Dictionary(Of TKey, TValue) class allows the user to specify the IComparer(Of T) 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(Of TKey, TValue).

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

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

Universal Windows Platform
Available since 8
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top