Remove, méthode (objet Collection)

Mise à jour : novembre 2007

Supprime un élément d'un objet Collection.

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

Paramètres

  • Key
    Expression String unique qui spécifie une chaîne clé pouvant être utilisée à la place d'un index positionnel pour accéder à un élément de la collection. Key doit correspondre à l'argument Key spécifié lors de l'ajout de l'élément à la collection.

  • Index
    Expression numérique qui spécifie la position d'un élément de la collection. Index doit être un nombre compris entre 1 et la valeur du Count, propriété (objet Collection) de la collection.

Exceptions

Type d'exception

Numéro de l'erreur

Condition

ArgumentException

5

Key n'est pas valide ou n'est pas spécifié.

IndexOutOfRangeException

9

Index ne correspond à aucun membre existant de la collection.

Consultez la colonne « Numéro d'erreur » si vous mettez à niveau des applications Visual Basic 6.0 qui utilisent la gestion non structurée des erreurs. (Vous pouvez comparer le numéro d'erreur par rapport à Number, propriété (objet Err).) Toutefois, lorsque cela est possible, vous devez envisager de remplacer un tel contrôle d'erreurs par Vue d'ensemble de la gestion structurée des exceptions pour Visual Basic.

Notes

Lorsque Remove supprime un élément d'une collection, il décrémente la collection Count, propriété (objet Collection) de un. Il décrémente également la valeur Index de chaque élément qui suivait précédemment l'élément supprimé dans la collection.

Si un élément a été ajouté à la collection sans Key, vous devez utiliser son Index pour le supprimer.

Exemple

Cet exemple montre comment utiliser la méthode Remove pour supprimer des objets d'un Collection, objet (Visual Basic) de la 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")

À la suite des quatre appels à la méthode Add, la propriété Count contient 4, le "Bill" d'élément a la valeur d'index 1, et le "Pete" d'élément a la valeur d'index 4.

À la suite du premier appel à Remove, Count est égal à 3, le "Bill" d'élément est supprimé, et le "Pete" d'élément a la valeur d'index 3.

À la suite du second appel à Remove, Count est égal à 2, le "Mike" d'élément est supprimé, et le "Pete" d'élément a la valeur d'index 2.

Configuration requise

Espace de noms :Microsoft.VisualBasic

**Module :**Collection

**Assembly :**bibliothèque Visual Basic Runtime (dans Microsoft.VisualBasic.dll)

Voir aussi

Référence

Collection, objet (Visual Basic)

Add, méthode (objet Collection)