Contains-Methode (Collection-Objekt)

Artikel
09/02/2008

Aktualisiert: November 2007

Gibt einen Boolean-Wert zurück, der angibt, ob ein Collection-Objekt in Visual Basic ein Element mit einem bestimmten Schlüssel enthält.

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

Parameter

Key
Erforderlich. Ein String-Ausdruck, der den Schlüssel angibt, nach dem die Elemente der Auflistung zu durchsuchen sind.

Ausnahmen/Fehlercodes

Ausnahmetyp	Fehlernummer	Bedingung
ArgumentException	5	Der angegebene Key ergibt Nothing.

Beachten Sie die Spalte "Fehlernummer", wenn Sie Visual Basic 6.0-Anwendungen aktualisieren, die eine unstrukturierte Fehlerbehandlung verwenden. (Sie können die Fehlernummer mit der Number-Eigenschaft (Err-Objekt) vergleichen.) Wenn möglich, sollten Sie jedoch erwägen, eine solche Fehlersteuerung durch eine Übersicht über die strukturierte Ausnahmebehandlung für Visual Basic zu ersetzen.

Hinweise

Contains gibt True zurück, wenn die Auflistung ein Element mit einem Schlüssel enthält, der genau mit Key übereinstimmt. Andernfalls gibt ContainsFalse zurück.

In einer Visual Basic-Collection können Elemente abgelegt werden, die Schlüssel enthalten, und andere Elemente ohne Schlüssel. Dies hängt davon ab, ob im Aufruf der Add-Methode (Collection-Objekt) ein Argument für den optionalen Key-Parameter angegeben wird.

Beispiel

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

Wenn Sie die Auflistung mithilfe der Schlüssel nach Elementen durchsuchen möchten, müssen Sie bei jedem Aufruf der Add-Methode das Key-Argument angeben.