ImmutableDictionary<TKey,TValue>.Builder.Remove Method
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.
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. |
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
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 |
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
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 |
.NET feedback
.NET is an open source project. Select a link to provide feedback: