Connectivity Software User's Guide and Reference
RemoveExisting<T> Method



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Collections.Generic.Extensions Namespace > ICollectionExtension Class : RemoveExisting<T> Method
The type of elements in the collection.
The collection from which the item will be removed. Must not be null.

The value of this parameter cannot be null (Nothing in Visual Basic).

The individual elements of the parameter value can be null (Nothing in Visual Basic).

The item to remove from the collection. Must not be null.

The value of this parameter cannot be null (Nothing in Visual Basic).

Removes an existing item from the specified collection.
Syntax
'Declaration
 
<ExtensionAttribute()>
Public Shared Sub RemoveExisting(Of T)( _
   ByVal collection As ICollection(Of T), _
   ByVal item As T _
) 
'Usage
 
Dim collection As ICollection(Of T)
Dim item As T
 
ICollectionExtension.RemoveExisting(Of T)(collection, item)
[Extension()]
public static void RemoveExisting<T>( 
   ICollection<T> collection,
   T item
)
[Extension()]
public:
static void RemoveExistinggeneric<typename T>
( 
   ICollection<T^>^ collection,
   T^ item
) 

Parameters

collection
The collection from which the item will be removed. Must not be null.

The value of this parameter cannot be null (Nothing in Visual Basic).

The individual elements of the parameter value can be null (Nothing in Visual Basic).

item
The item to remove from the collection. Must not be null.

The value of this parameter cannot be null (Nothing in Visual Basic).

Type Parameters

T
The type of elements in the collection.
Exceptions
ExceptionDescription
Thrown if collection or item is null.
Thrown if the specified item does not exist in the collection.
Remarks

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

See Also