Export (0) Print
Expand All
Expand Minimize
1 out of 2 rated this helpful - Rate this topic

Filter Function

Returns a zero-based array containing a subset of a string array based on a specified filter criteria.

                      Filter(InputStrings, Value[, Include[, Compare]])
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.

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 Filter function contains only enough elements to contain the number of matched items.

The following example uses the Filter function to return the array containing the search criteria "Mon":

Dim MyIndex
Dim MyArray (3)
MyArray(0) = "Sunday"
MyArray(1) = "Monday"
MyArray(2) = "Tuesday"
MyIndex = Filter(MyArray, "Mon") ' MyIndex(0) contains "Monday".

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.