Collection.Remove Method (String)

Removes an element from a Collection object.

Namespace:  Microsoft.VisualBasic
Assembly:  Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)

public void Remove(
	string Key
)

Parameters

Key
Type: System.String

A unique String expression that specifies a key string that can be used, instead of a positional index, to access an element of the collection. Key must correspond to the Key argument specified when the element was added to the collection.

When Remove deletes an element from a collection, it decrements the collection's Count property by one. It also decrements the Index value of every element that formerly followed the deleted element in the collection.

If an element was added to the collection without a Key, you must use its Index to remove it.

This example illustrates the use of the Remove method to remove objects from a Collection object in the variable birthdays.

Dim birthdays As New Collection()
birthdays.Add(New DateTime(2001, 1, 12), "Bill")
birthdays.Add(New DateTime(2001, 1, 13), "Joe")
birthdays.Add(New DateTime(2001, 1, 14), "Mike")
birthdays.Add(New DateTime(2001, 1, 15), "Pete")


...


birthdays.Remove(1)
birthdays.Remove("Mike")

Following the four calls to the Add method, the Count property contains 4, element "Bill" has index value 1, and element "Pete" has index value 4.

Following the first call to Remove, Count is 3, element "Bill" is deleted, and element "Pete" has index value 3.

Following the second call to Remove, Count is 2, element "Mike" is deleted, and element "Pete" has index value 2.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft