Dictionary<TKey,TValue>.KeyCollection.ICollection<TKey>.Remove Method

Definition

Namespace:

System.Collections.Generic

Assembly:

System.Collections.dll

Source:

Dictionary.cs

Removes the first occurrence of a specific object from the ICollection<T>. This implementation always throws NotSupportedException.

 virtual bool System.Collections.Generic.ICollection<TKey>.Remove(TKey item) = System::Collections::Generic::ICollection<TKey>::Remove;

bool ICollection<TKey>.Remove (TKey item);

abstract member System.Collections.Generic.ICollection<TKey>.Remove : 'Key -> bool
override this.System.Collections.Generic.ICollection<TKey>.Remove : 'Key -> bool

Function Remove (item As TKey) As Boolean Implements ICollection(Of TKey).Remove

Parameters

item

TKey

The object to remove from the ICollection<T>.

Returns

Boolean

true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item was not found in the original ICollection<T>.

Implements

Remove(T)

Exceptions

NotSupportedException

Always thrown.

Remarks

Implementations can vary in how they determine equality of objects; for example, List<T> uses Default, whereas, Dictionary<TKey,TValue> allows the user to specify the IComparer<T> implementation to use for comparing keys.

See also

• IsReadOnly