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