Collection.Remove Method

Definition

Namespace:

Microsoft.VisualBasic

Assembly:

Microsoft.VisualBasic.Core.dll

Removes an element from a Collection object.

Overloads

Remove(Int32)	Removes an element from a Collection object.
Remove(String)	Removes an element from a Collection object.

Remove(Int32)

Source:

Collection.vb

Removes an element from a Collection object.

public:
 void Remove(int Index);

public void Remove (int Index);

member this.Remove : int -> unit

Public Sub Remove (Index As Integer)

Parameters

Index

Int32

A numeric expression that specifies the position of an element of the collection. Index must be a number from 1 through the value of the collection's Count property.

Examples

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.

Remarks

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.

Remove(String)

Source:

Collection.vb

Removes an element from a Collection object.

public:
 void Remove(System::String ^ Key);

public void Remove (string Key);

member this.Remove : string -> unit

Public Sub Remove (Key As String)

Parameters

Key

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.

Examples

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.

Remarks

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.