Dictionary(Of TKey, TValue).Remove Method

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

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

'Declaration
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).

Implements

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

ExceptionCondition
ArgumentNullException

key is Nothing.

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.


' Use the Remove method to remove a key/value pair.
outputBlock.Text &= vbLf + "Remove(""doc"")" & vbCrLf
openWith.Remove("doc")

If Not openWith.ContainsKey("doc") Then
   outputBlock.Text &= "Key ""doc"" is not found." & vbCrLf
End If


Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Community Additions

ADD
Show: