Método Contains (Objeto Coleção)

Artigo
08/25/2010

Retorna um valor Boolean indicando se um objeto Collection Visual Basic contém um elemento com uma chave específica.

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

Parâmetros

Key
Obrigatório.Uma expressão String que especifica a chave com a qual pesquisar os elementos da coleção.

Exceções/Códigos de erros

Tipo de exceção	Número de erro	Condição
ArgumentException	5	A Key especificada é Nothing.

Ver a coluna " número de erro " se você estiver atualizando aplicativos Visual Basic 6.0 que usam manipulação de erros não estruturada.(Você pode comparar o número do erro com a Propriedade do Número (Erro de objeto).) Entretanto, quando for possivel, você pode considerar substituir tal controle de erro por Visão Geral sobre a Manipulação Estruturada de Exceções para o Visual Basic.

Comentários

Contains retorna True se a coleção contém um elemento com uma chave exatamente correspondente a Key.Caso contrário, Contains retornará False.

Uma Collection Visual Basic pode conter alguns elementos que tenham chaves e outros elementos sem chaves.Isso depende se a chamada para o Método Add (objeto da coleção) fornece um argumento para o parâmetro opcional Key.

Exemplo

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

Se você pretende pesquisar a coleção de elementos usando suas chaves, lembre-se fornecer o argumento Key toda vez que você chamar o método Add.