ICollection<T>.Remove(T) 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>.
public:
bool Remove(T item);
public bool Remove (T item);
abstract member Remove : 'T -> bool
Public Function Remove (item As T) As Boolean
Parameters
- item
- T
The object to remove from the ICollection<T>.
Returns
true
if item
was successfully removed from the ICollection<T>; otherwise, false
. This method also returns false
if item
is not found in the original ICollection<T>.
Exceptions
The ICollection<T> is read-only.
Remarks
Implementations can vary in how they determine equality of objects; for example, List<T> uses Comparer<T>.Default, whereas, Dictionary<TKey,TValue> allows the user to specify the IComparer<T> implementation to use for comparing keys.
In collections of contiguous elements, such as lists, the elements that follow the removed element move up to occupy the vacated spot. If the collection is indexed, the indexes of the elements that are moved are also updated. This behavior does not apply to collections where elements are conceptually grouped into buckets, such as a hash table.