Метод Contains (объект Collection)

Статья
11/05/2008

Обновлен: Ноябрь 2007

Возвращает значение Boolean, показывающее, содержит ли объект Visual Basic Collection элемент с указанным ключом.

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

Параметры

Key
Обязателен. Выражение типа String, которое задает ключ для поиска элементов коллекции.

Исключения и коды ошибок

Тип исключения	Номер ошибки	Условия
ArgumentException	5	Указанный Key имеет значение Nothing.

См. столбец "Номер ошибки", если выполняется обновление приложений Visual Basic 6.0, в которых используется неструктурированная обработка ошибок. (Можно сравнить номер ошибки с Свойство Number (объект Err).) Однако по возможности следует заменить такую систему управления ошибками на Обзор структурной обработки исключений в Visual Basic.

Заметки

Contains возвращает True, если коллекция содержит элемент с ключом, точно соответствующим Key. В противном случае Contains возвращает False.

Visual Basic Collection может содержать элементы как имеющие ключи, так и не имеющие их. Это зависит от того, предоставляет ли вызов Метод Add (объект Collection) аргумент для необязательного параметра Key.

Пример

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

Если планируется поиск элементов в коллекции по ключам, не забудьте указывать аргумент Key при каждом вызове метода Add.