Remove Method

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

 

Removes the value with the specified key from the Dictionary(Of TKey, TValue).

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

Public Function Remove (
	key As TKey
) As Boolean

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

Exception Condition
ArgumentNullException

key is null.

If the Dictionary(Of TKey, TValue) does not contain an element with the specified key, the Dictionary(Of 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(Of TKey, TValue) class (openWith is the name of the Dictionary used in this example).

' 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

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