Partager via

Remove Method (Collection Object) 

  • Article

Removes an element from a Collection object.

Public Overloads Sub Remove(_
    ByVal { Key As String | Index As Integer } _
)

Parameters

  • Key
    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.
  • Index
    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 (Collection Object).

Exceptions

Exception type Error number Condition

ArgumentException

5

Key is invalid or not specified.

IndexOutOfRangeException

9

Index does not match an existing element of the collection.

See the "Error number" column if you are upgrading Visual Basic 6.0 applications that use unstructured error handling. (You can compare the error number against the Number Property (Err Object).) However, when possible, you should consider replacing such error control with Structured Exception Handling Overview for Visual Basic.

Remarks

When Remove deletes an element from a collection, it decrements the collection's Count Property (Collection Object) 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.

Example

This example illustrates the use of the Remove method to remove objects from a Collection Object (Visual Basic) 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.

Requirements

Namespace: Microsoft.VisualBasic

Module: Collection

Assembly: Visual Basic Runtime Library (in Microsoft.VisualBasic.dll)

See Also

Reference

Collection Object (Visual Basic)
Add Method (Collection Object)