SortedDictionary<TKey,TValue>.KeyCollection.ICollection<TKey>.Remove Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Removes the first occurrence of a specific object from the ICollection<T>. This implementation always throws a 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
true
if item is successfully removed from the ICollection<T>; otherwise, false
. This method also returns false
if item is not found in the ICollection<T>.
Implements
Exceptions
Always thrown; the collection is read-only.
Remarks
Implementations can vary in how they determine equality of objects; for example, List<T> uses Default, whereas SortedDictionary<TKey,TValue> allows the user to specify the IComparer<T> implementation to use for comparing keys.