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)

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