SortedDictionary<TKey,TValue>.Remove(TKey) Method

Definition

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

C#
public bool Remove(TKey key);

Parameters

key
TKey

The key of the element to remove.

Returns

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

Exceptions

key is null.

Examples

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.

C#
// 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.");
}

Remarks

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.

Applies to

Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0

See also