ImmutableDictionary<TKey,TValue>.Builder.Remove Method

Definition

Namespace:

System.Collections.Immutable

Assembly:

System.Collections.Immutable.dll

Package:

System.Collections.Immutable v9.0.0-rc.2.24473.5

Overloads

Remove(KeyValuePair<TKey,TValue>)	Removes the first occurrence of a specific object from the immutable dictionary.
Remove(TKey)	Removes the element with the specified key from the immutable dictionary.

Remove(KeyValuePair<TKey,TValue>)

Source:

ImmutableDictionary_2.Builder.cs

Removes the first occurrence of a specific object from the immutable dictionary.

public:
 virtual bool Remove(System::Collections::Generic::KeyValuePair<TKey, TValue> item);

public bool Remove (System.Collections.Generic.KeyValuePair<TKey,TValue> item);

abstract member Remove : System.Collections.Generic.KeyValuePair<'Key, 'Value> -> bool
override this.Remove : System.Collections.Generic.KeyValuePair<'Key, 'Value> -> bool

Public Function Remove (item As KeyValuePair(Of TKey, TValue)) As Boolean

Parameters

item

KeyValuePair<TKey,TValue>

The object to remove from the dictionary.

Returns

Boolean

true if item was successfully removed from the dictionary; otherwise, false. This method also returns false if item is not found in the dictionary.

Implements

Remove(T)

Exceptions

NotSupportedException

The dictionary is read-only.

Remove(TKey)

Source:

ImmutableDictionary_2.Builder.cs

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

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

Boolean

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

Implements

Remove(TKey)

Exceptions

ArgumentNullException

key is null.

NotSupportedException

The dictionary is read-only.