OrderedDictionaryTKey, TValueRemove(TKey) Method

Removes the value with the specified key from the OrderedDictionaryTKey, TValue as an O(n) operation.

Namespace: GSF.Collections
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.181-beta

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 found and removed; otherwise, false. This method returns false if key is not found in the OrderedDictionaryTKey, TValue.

Implements

IDictionaryTKey, TValueRemove(TKey)

Exceptions

Exception	Condition
ArgumentNullException	key is null.

Reference

OrderedDictionaryTKey, TValue Class

Remove Overload

GSF.Collections Namespace