Filter, fonction

Microsoft VBScript

Microsoft® Visual Basic® Scripting Edition Filter, fonction Référence du langage 
Version 2 


Description
Renvoie un tableau commençant par zéro contenant un sous-ensemble d'un tableau de chaîne basé sur des critères de filtre spécifiés.
Syntaxe
Filter( InputStrings, Value[, Include[, Compare]])

La syntaxe de la fonction Filter comprend les éléments suivants :

élément Description
InputStrings Tableau de chaîne à une dimension dans lequel la recherche doit être effectuée.
Value Chaîne à rechercher.
Include Facultatif. Valeur de type Boolean indiquant s'il faut renvoyer des sous-chaînes incluant ou excluant l'argument Value. Si l'argument Include a la valeur True, la fonction Filter renvoie le sous-ensemble du tableau contenant l'argument Value comme sous-chaîne. Si l'argument Include a la valeur False, la fonction Filter renvoie le sous-ensemble du tableau ne contenant pas l'argument Value comme sous-chaîne.
Compare Facultatif. Valeur numérique indiquant le type de comparaison de chaîne à utiliser. Reportez-vous à la section Valeurs.

Valeurs
L'argument Compare peut prendre les valeurs suivantes :

Constante Valeur Description
vbBinaryCompare 0 Effectue une comparaison binaire.
vbTextCompare 1 Effectue une comparaison texte.

Notes
Si aucune correspondance de l'argument Value n'est trouvée dans l'argument InputStrings, la fonction Filter renvoie un tableau vide. Une erreur se produit si l'argument InputStrings a la valeur Null ou s'il ne correspond pas à un tableau à une dimension.

Le tableau renvoyé par la fonction Filter ne contient que le nombre d'éléments suffisants pour accueillir le nombre d'éléments en correspondance.

L'exemple ci-dessous utilise la fonction Filter pour renvoyer le tableau contenant le critère de recherche "Lun" :

Dim MyIndex
Dim MyArray (3)
MyArray(0) = "Dimanche"
MyArray(1) = "Lundi"
MyArray(2) = "Mardi"
MyIndex = Filter(MyArray, "Lun") 
' MyIndex(0) contient "Lundi".