Click or drag to resize

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.207-beta+1781b796b2aa7a54013a031eb432fe4ccee31867
Syntax
public bool Remove(
	TKey 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
ExceptionCondition
ArgumentNullExceptionkey is null.
NotSupportedExceptionThe IDictionaryTKey, TValue is read-only.
See Also