VBScript Filter function
May 13, 2021 VBScript
Table of contents
VBScript Filter function
The VBScript Filter function returns an array with a subset of strings with a lower limit of 0, depending on the filter specified.
Complete VBScript reference manual
The Filter function returns a 0-based array that contains a subset of string arrays based on a particular filter.
Note: If no value can be found that matches the value parameter, the Filter function returns an empty array.
Note: An error occurs if the parameter inputstrings is Null or is not a one-dimensional array.
Grammar
Parameters
| parameter | describe |
|---|---|
| inputstrings | Required.A one-dimensional string array to retrieve. |
| value | Required.String to search. |
| include | Optional.Boolean value, specify whether the returned sub-string contains Value.If INCLUDE is True, Filter will return an array subset that contains the substring value.If INCLUDE is False, Filter will return an array subset that does not contain sub-string value VALUE.The default is TRUE. |
| compare |
Optional.The string comparison type to use is specified.
The following values can be used:
|
Instance 1
Filter: The project contains an "S":
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 above example output results:
Saturday
Try it out . . .
Instance 2
Filter: "S" that is not included in the project:
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 above example output results:
Tuesday
Wednesday
Thursday
Friday
Try it out . . .
Instance 3
Filter: Items that contain "S" are compared in text (compare=1):
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 above example output results:
Tuesday
Wednesday
Thursday
Saturday
Try it out . . .
Complete VBScript reference manual