ImmutableDictionaryTKey, TValueRemove(TKey) Method

Removes the element with the specified key from the IDictionaryTKey, TValue.

Namespace: GSF.Immutable
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.257-beta+00aa2366fbb9ec75f636ebc7cfa610e3826a727c

Syntax

C++

JavaScript

Copy

public bool Remove(
	TKey key
)

Public Function Remove ( 
	key As TKey
) As Boolean

public:
virtual bool Remove(
	TKey key
) sealed

abstract Remove : 
        key : 'TKey -> bool 
override Remove : 
        key : 'TKey -> bool

function Remove(key);

View Source

Parameters

key TKey: The key of the element to remove.

Return Value

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

Implements

IDictionaryTKey, TValueRemove(TKey)

Exceptions

Exception	Condition
ArgumentNullException	key is null.
NotSupportedException	The IDictionaryTKey, TValue is read-only.

Reference

ImmutableDictionaryTKey, TValue Class

Remove Overload

GSF.Immutable Namespace