ImmutableDictionary<TKey,TValue>.IDictionary<TKey,TValue>.Remove Method

Definition

Namespace:

System.Collections.Immutable

Assembly:

System.Collections.Immutable.dll

Source:

ImmutableDictionary_2.cs

Removes the element with the specified key from the generic dictionary.

 virtual bool System.Collections.Generic.IDictionary<TKey,TValue>.Remove(TKey key) = System::Collections::Generic::IDictionary<TKey, TValue>::Remove;

bool IDictionary<TKey,TValue>.Remove (TKey key);

abstract member System.Collections.Generic.IDictionary<TKey,TValue>.Remove : 'Key -> bool
override this.System.Collections.Generic.IDictionary<TKey,TValue>.Remove : 'Key -> bool

Function Remove (key As TKey) As Boolean Implements IDictionary(Of TKey, TValue).Remove

Parameters

key

TKey

The key of the element to remove.

Returns

Boolean

true if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the original generic dictionary.

Implements

Remove(TKey)

Exceptions

ArgumentNullException

key is null.

NotSupportedException

The IDictionary<TKey,TValue> is read-only.