This is preliminary documentation and subject to change.
To comment on this topic, please send us email at ngwssdk@microsoft.com. Thanks!
Filter Function
Returns a zero-based array containing subset of a string array based on a specified filter criteria.
Filter(sourcearray, match[, include[, compare]])
Arguments
- 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 |
BinaryCompare |
0 |
Performs a binary comparison. |
TextCompare |
1 |
Performs a textual comparison. |
Remarks
If no matches of match are found within sourcearray, Filter returns an empty array. An error occurs if sourcearray is set to Nothing 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.
See Also
Replace Function