SortedDictionary.System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<TKey,TValue>>.Remove Method

Article
12/04/2006

Note: This method is new in the .NET Framework version 2.0.

Removes the first occurrence of the specified element from the ICollection.

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

Syntax

'Declaration
Private Function System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<TKey,TValue>>.Remove ( _
    keyValuePair As KeyValuePair(Of TKey, TValue) _
) As Boolean Implements ICollection(Of KeyValuePair(Of TKey, TValue)).Remove
'Usage
Dim instance As SortedDictionary(Of TKey, TValue)
Dim keyValuePair As KeyValuePair(Of TKey, TValue)
Dim returnValue As Boolean

returnValue = CType(instance, ICollection(Of KeyValuePair(Of TKey, TValue))).Remove(keyValuePair)

bool ICollection<KeyValuePair<TKey,TValue>>.Remove (
    KeyValuePair<TKey,TValue> keyValuePair
)

private:
virtual bool System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<TKey,TValue>>.Remove (
    KeyValuePair<TKey, TValue> keyValuePair
) sealed = ICollection<KeyValuePair<TKey, TValue>>::Remove

J# supports the use of explicit interface implementations, but not the declaration of new ones.

JScript supports the use of explicit interface implementations, but not the declarations of new ones.

Parameters

keyValuePair
The KeyValuePair structure to remove from the ICollection.

Return Value

true if keyValuePair was successfully removed from the ICollection; otherwise, false. This method also returns false if keyValuePair was not found in the ICollection.

Remarks

This method determines equality by first using the Comparer property for the key and then using EqualityComparer.Default for the value.

This method is an O(log n) operation.

Platforms

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

Version Information

.NET Framework

Supported in: 2.0