FileBackedDictionary<TKey, TValue> .Remove(TKey) Method

Removes the element with the specified key from the FileBackedDictionary<TKey, TValue>.

Namespace: GSF.Collections
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.241-beta+912389e96d98840d2a999d490420db618dcbe4c6

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 FileBackedDictionary<TKey, TValue>.

Implements

IDictionary<TKey, TValue>.Remove(TKey)

Exceptions

Exception	Condition
ArgumentNullException	key is null.
NotSupportedException	The FileBackedDictionary<TKey, TValue> is read-only.

Reference

FileBackedDictionary<TKey, TValue> Class

Remove Overload

GSF.Collections Namespace