Contains (Método, objeto Collection)

Artículo
10/07/2008

Actualización: noviembre 2007

Devuelve un valor Boolean que indica si un objeto Collection de Visual Basic contiene un elemento con una clave concreta.

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

Parámetros

Key
Requerido. Una expresión de tipo String que especifica la clave para la que se buscan los elementos de la colección.

Excepciones/Códigos de error

Tipo de excepción	Número de error	Condición
ArgumentException		El parámetro Key especificado es Nothing.

Consulte la columna "Número de error" si está actualizando aplicaciones de Visual Basic 6.0 que utilizan el control de errores no estructurado. (Se puede comparar el número de error con respecto a Number (Propiedad, objeto Err)). Sin embargo, siempre que sea posible, se debe considerar la sustitución de dicho control de errores por Información general sobre el control estructurado de excepciones de Visual Basic.

Comentarios

Contains devuelve True si la colección contiene un elemento con una clave que coincide exactamente con Key. De lo contrario, Contains devuelve False.

Un objeto Collection de Visual Basic puede contener algunos elementos que tienen claves y otros elementos sin claves. Esto depende de si la llamada a Add (Método, objeto Collection) proporciona un argumento al parámetro Key opcional.

Ejemplo

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 piensa buscar en la colección elementos mediante sus claves, no olvide incluir el argumento Key cada vez que llame al método Add.