Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

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

Definition

Namespace:
System.Collections.Generic
Assemblies:
System.dll, System.Collections.dll
Assemblies:
netstandard.dll, System.Collections.dll
Assembly:
System.Collections.dll
Assembly:
System.dll
Assembly:
netstandard.dll
Source:
SortedDictionary.cs
Source:
SortedDictionary.cs
Source:
SortedDictionary.cs
Source:
SortedDictionary.cs
Source:
SortedDictionary.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 virtual bool Remove(TKey key);
public bool Remove(TKey key);
abstract member Remove : 'Key -> bool
override this.Remove : 'Key -> bool
Public Function Remove (key As TKey) As Boolean

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.

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

' Use the Remove method to remove a key/value pair.
Console.WriteLine(vbLf + "Remove(""doc"")")
openWith.Remove("doc")

If Not openWith.ContainsKey("doc") Then
 Console.WriteLine("Key ""doc"" is not found.")
End If

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

See also

Feedback

Was this page helpful?