Filter Function
Description
Returns a zero-based array containing subset of a string array based on a specified filter criteria.
Syntax
Filter(sourcesrray, match[, include[, compare]])
The Filter function syntax has these named argument:
| Part | Description |
|---|---|
| sourcearray | Required. One-dimensional array of strings to be searched. |
| match | Required. String to search for. |
| include | Optional. Boolean value indicating whether to return substrings that include or exclude match. If include is True, Filter returns the subset of the array that contains match as a substring. If include is False, Filter returns the subset of the array that does not contain match as a substring. |
| compare | Optional. Numeric value indicating the kind of string comparison to use. See Settings section for values. |
Settings
The compare argument can have the following values:
| Constant | Value | Description |
|---|---|---|
| vbUseCompareOption | -1 | Performs a comparison using the setting of the Option Compare statement. |
| vbBinaryCompare | 0 | Performs a binary comparison. |
| vbTextCompare | 1 | Performs a textual comparison. |
| vbDatabaseCompare | 2 | Microsoft Access only. Performs a comparison based on information in your database. |
Remarks
If no matches of match are found within sourcearray, Filter returns an empty array. An error occurs if sourcearray is Null or is not a one-dimensional array.
The array returned by the Filter function contains only enough elements to contain the number of matched items.