Contains, méthode (objet Collection)

Article
09/12/2008

Mise à jour : novembre 2007

Retourne une valeur Boolean indiquant si un objet Visual Basic Collection contient un élément avec une clé spécifique.

Public Function Contains( _
    ByVal Key As String _
) As Boolean

Paramètres

Key
Obligatoire. Expression String qui spécifie la clé à rechercher dans les éléments de la collection.

Exceptions/Codes d'erreur

Type d'exception	Numéro de l'erreur	Condition
ArgumentException	5	Le Key spécifié a la valeur Nothing.

Consultez la colonne « Numéro d'erreur » si vous mettez à niveau des applications Visual Basic 6.0 qui utilisent la gestion des erreurs non structurée. (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'erreur par Vue d'ensemble de la gestion structurée des exceptions pour Visual Basic.

Notes

Contains retourne True si la collection contient un élément assorti d'une clé correspondant exactement à Key. Sinon, Contains retourne False.

Un Collection Visual Basic peut contenir certains éléments pourvus de clés et d'autres qui en sont dépourvus, selon que l'appel à Add, méthode (objet Collection) fournit un argument au paramètre facultatif Key.

Exemple

Dim customers As New Microsoft.VisualBasic.Collection()
Dim accountNumber As String = "1234"
' Insert code that obtains new customer objects.
' Use the new customer's account number as the key.
customers.Add(newCustomer, accountNumber)
' The preceding statements can be repeated for several customers.
Dim searchNumber As String = "1234"
' Insert code to obtain an account number to search for.
If customers.Contains(searchNumber) Then
    MsgBox("The desired customer is in the collection.")
Else
    MsgBox("The desired customer is not in the collection.")
End If

Si vous envisagez de rechercher dans la collection des éléments à l'aide de leur clé, pensez à fournir l'argument Key chaque fois que vous appelez la méthode Add.