Filter, fonction (Visual Basic)

Article
09/12/2008

Mise à jour : novembre 2007

Retourne un tableau de base zéro et contenant un sous-ensemble d'un tableau de chaînes (String) basé sur des critères de filtre spécifiés.

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()

Paramètres

Source
Requis. Tableau de chaînes à une dimension dans lequel la recherche doit être effectuée.
Match
Requis. Chaîne à rechercher.
Include
Facultatif. Valeur de type Boolean indiquant s'il faut retourner des sous-chaînes incluant ou excluant l'argument Match. Si l'argument Include a la valeur True, la fonction Filter retourne le sous-ensemble du tableau contenant l'argument Match comme sous-chaîne. Si l'argument Include a la valeur False, la fonction Filter retourne le sous-ensemble du tableau qui ne contient pas l'argument Match comme sous-chaîne.
Compare
Facultatif. Valeur numérique indiquant le type de comparaison de chaîne à utiliser. Consultez la section « Paramètres » pour obtenir les valeurs.

Paramètres

L'argument Compare peut prendre les valeurs suivantes.

Constante	Description
CompareMethod.Binary	Effectue une comparaison binaire.
CompareMethod.Text	Effectue une comparaison de texte.

Exceptions

Type d'exception	Numéro de l'erreur	Condition
ArgumentException	9	Source a la valeur Nothing ou n'est pas un tableau unidimensionnel.

Consultez la colonne « Numéro d'erreur » si vous mettez à niveau des applications Visual Basic 6.0 qui utilisent la gestion des erreurs non structurée. (Vous pouvez comparer le numéro d'erreur par rapport à Number, propriété (objet Err).) Toutefois, lorsque cela est possible, vous devez envisager de remplacer un tel contrôle d'erreur par Vue d'ensemble de la gestion structurée des exceptions pour Visual Basic.

Notes

Si aucune correspondance de Match n'est obtenue dans Source, la fonction Filter retourne un tableau vide. Une erreur se produit si l'argument Source est Nothing ou s'il ne s'agit pas d'un tableau à une dimension.

Le tableau retourné par la fonction Filter comporte uniquement le nombre d'éléments suffisants pour contenir le nombre d'éléments de travail correspondants.

Exemple

Cet exemple illustre l'utilisation de la fonction 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)