Filter (Función, Visual Basic)

Actualización: noviembre 2007

Devuelve una matriz basada en cero que contiene un subconjunto de una matriz String basada en criterios de filtro especificados.

Function Filter(
   ByVal Source() As { Object | String },
   ByVal Match As String,
   Optional ByVal Include As Boolean = True,
   Optional ByVal Compare As CompareMethod = CompareMethod.Binary
)  As String()

Parámetros

• Source
  Requerido. Matriz unidimensional de cadenas en la que se realizará la búsqueda.

• Match
  Requerido. Cadena que se va a buscar.

• Include
  Opcional. Valor Boolean que indica si se han de devolver las subcadenas que incluyan o excluyan Match. Si Include tiene el valor True, la función Filter devuelve el subconjunto de la matriz que contiene Match como una subcadena. Si Include tiene el valor False, la función Filter devuelve el subconjunto de la matriz que no contiene Match como una subcadena.

• Compare
  Opcional. Valor numérico que indica el tipo de comparación de cadenas que se ha de utilizar. Vea la sección "Valores" para conocer los valores utilizados.

Valores

El argumento Compare puede tener los siguientes valores:

Excepciones

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

Si no se encuentra ninguna coincidencia de Match en Source, la función Filter devuelve una matriz vacía. Si Source se establece en Nothing o no es una matriz unidimensional, se producirá un error.

La matriz devuelta por la función Filter sólo dispone de los elementos justos para contener el número de elementos coincidentes.

Ejemplo

En este ejemplo se muestra el uso de la función Filter.

Dim TestStrings(2) As String
TestStrings(0) = "This"
TestStrings(1) = "Is"
TestStrings(2) = "It"
Dim subStrings() As String
' Returns ["This", "Is"].
subStrings = Filter(TestStrings, "is", True, CompareMethod.Text)
' Returns ["This"].
subStrings = Filter(TestStrings, "is", True, CompareMethod.Binary)
' Returns ["Is", "It"].
subStrings = Filter(TestStrings, "is", False, CompareMethod.Binary)

Requisitos

Espacio de nombres:Microsoft.VisualBasic

**Módulo:**Strings

**Ensamblado:**Visual Basic Runtime Library (en Microsoft.VisualBasic.dll)

Vea también

Referencia

Resumen de manipulación de cadenas

Replace (Función, Visual Basic)

ArgumentException