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

 

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

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

bool IDictionary<TKey, TValue>.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 was not found in the original dictionary.

Exception Condition
ArgumentNullException

key is null.

NotSupportedException

The dictionary is read-only.

This member is an explicit interface member implementation. It can be used only when the ImmutableDictionary<TKey, TValue> instance is cast to an IDictionary<TKey, TValue> interface.

Return to top
Show: