W3Schools.com

VBScript Filter Function

VBScript Reference 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 »
VBScript Reference Complete VBScript Reference
WEB HOSTING
Best Web Hosting
PHP MySQL Hosting
Best Hosting Coupons
UK Reseller Hosting
Cloud Hosting
Top Web Hosting
$7.95/mo SEO Hosting
Premium Website Design
WEB BUILDING
Download XML Editor
FREE Website BUILDER
Free Website Templates Free CSS Templates
Make Your Own Website
W3SCHOOLS EXAMS
Get Certified in:
HTML, CSS, JavaScript, XML, PHP, and ASP
W3SCHOOLS BOOKS
New Books:
HTML, CSS
JavaScript, and Ajax
STATISTICS
Browser Statistics
Browser OS
Browser Display
SHARE THIS PAGE