VBScript Filter Function

## VBScript Tutorial

VB HOME VB How to VB Variables VB Procedures VB Conditional VB Looping VB Summary

## VB Examples

VB Examples

## VB References

VB Functions VB Keywords

# VBScript Filter Function

Complete VBScript Reference

The Filter function returns a zero-based array that contains a subset of a string array based on a filter criteria.

Note: If no matches of the value parameter are found, the Filter function will return an empty array.

Note: If the parameter inputstrings is Null or is NOT a one-dimensional array, an error will occur.

### Syntax

Filter(inputstrings,value[,include[,compare]])

Parameter | Description
--- | ---
inputstrings | Required. A one-dimensional array of strings to be searched
value | Required. The string to search for
include | Optional. A Boolean value that indicates whether to return the substrings that include or exclude value. True returns the subset of the array that contains value as a substring. False returns the subset of the array that does not contain value as a substring. Default is True.

compare

Optional. Specifies the string comparison to use.

Can have one of the following values:

- 0 = vbBinaryCompare - Perform a binary comparison
- 1 = vbTextCompare - Perform a textual comparison

## Examples

## Example 1

Filter: items that contains "S"

<script type="text/vbscript">
a=Array("Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday")
b=Filter(a,"S")
for each x in b
document.write(x & "<br />")
next
</script>

The output of the code above will be:

Sunday
Saturday
Try it yourself »

## Example 2

Filter: items that does NOT contain "S" (include=False):

<script type="text/vbscript">
a=Array("Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday")
b=Filter(a,"S",False)
for each x in b
document.write(x & "<br />")
next
</script>

The output of the code above will be:

Monday
Tuesday
Wednesday
Thursday
Friday
Try it yourself »

## Example 3

Filter: items that contains "S", with a textual comparison (compare=1):

<script type="text/vbscript">
a=Array("Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday")
b=Filter(a,"S",True,1)
for each x in b
document.write(x & "<br />")
next
</script>

The output of the code above will be:

Sunday
Tuesday
Wednesday
Thursday
Saturday
Try it yourself »

Complete VBScript Reference

## Your suggestion:

Your E-mail (optional):

Page address:

Description:

Close [X]

## Thank You For Helping Us!

Your message has been sent to W3Schools.

Close [X]
Search w3schools.com:

## WEB HOSTING

Best Web Hosting UK Reseller Hosting Wow! $5 SSD Hosting

## WEB BUILDING

Download XML Editor
FREE Website BUILDER FREE Website Creator

## WEB RESOURCES

Web Statistics Web Validation

## SHARE THIS PAGE