Export (0) Print
Expand All

SortedDictionary<TKey, TValue>.Remove Method

Removes the element with the specified key from the SortedDictionary<TKey, TValue>.

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

public bool Remove(
	TKey key
)

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 is not found in the SortedDictionary<TKey, TValue>.

Implements

IDictionary<TKey, TValue>.Remove(TKey)

ExceptionCondition
ArgumentNullException

key is null.

If the SortedDictionary<TKey, TValue> does not contain an element with the specified key, the SortedDictionary<TKey, TValue> remains unchanged. No exception is thrown.

This method is an O(log n) operation.

The following code example shows how to remove a key/value pair from the dictionary using the Remove method.

This code example is part of a larger example provided for the SortedDictionary<TKey, TValue> class.

// Use the Remove method to remove a key/value pair.
Console.WriteLine("\nRemove(\"doc\")");
openWith.Remove("doc");

if (!openWith.ContainsKey("doc"))
{
    Console.WriteLine("Key \"doc\" is not found.");
}

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

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

.NET Framework

Supported in: 3.5, 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft