ImmutableDictionary<TKey,TValue>.Builder.Remove Method

Definition

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
Source:
ImmutableDictionary_2.Builder.cs
Source:
ImmutableDictionary_2.Builder.cs
Source:
ImmutableDictionary_2.Builder.cs

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

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

Parameters

item
KeyValuePair<TKey,TValue>

The object to remove from the dictionary.

Returns

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

Exceptions

The dictionary is read-only.

Applies to

.NET 9 and other versions
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 (package-provided), 8, 9 (package-provided), 9
.NET Framework 4.7 (package-provided), 4.7.1 (package-provided), 4.7.2 (package-provided), 4.8 (package-provided)
.NET Standard 2.0 (package-provided)
UWP 10.0

Remove(TKey)

Source:
ImmutableDictionary_2.Builder.cs
Source:
ImmutableDictionary_2.Builder.cs
Source:
ImmutableDictionary_2.Builder.cs
Source:
ImmutableDictionary_2.Builder.cs

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

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 was not found in the dictionary.

Implements

Exceptions

key is null.

The dictionary is read-only.

Applies to

.NET 9 and other versions
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 (package-provided), 8, 9 (package-provided), 9
.NET Framework 4.7 (package-provided), 4.7.1 (package-provided), 4.7.2 (package-provided), 4.8 (package-provided)
.NET Standard 2.0 (package-provided)
UWP 10.0