Promotic

Filter - function of language VBScript

Description:
Returns an array (zero-based index) containing subset of a string array based on a specified filter criteria.
Syntax:
Array Filter(String InputStrings, String Value, [Boolean Include], [Integer Compare])
Parameters:
InputStrings(String) 1-dimensional array of strings to be searched.
Value(String) String to search for
Include[optional] (Boolean) Logical value indicating whether to return substrings that include or exclude Value
true (default) - function returns the subset of the array that contains value as a substring
false - function returns the subset of the array that does not contain value as a substring
Compare[optional] (Integer) Numeric value indicating the kind of string comparison to use. If not set, then a binary comparison is performed.
vbTextCompare (default) - perform a textual comparison
vbBinaryCompare - perform a binary comparison
Note:
If no matches of Value are found within InputStrings, then the function returns an empty array.
If InputStrings is Null or is not a 1-dimensional array then error occurs.
The array returned by the function contains only enough elements to contain the number of matched items.
See also:
- VBScript.Replace (function)
- VBScript array functions
- How to use array of values in the PROMOTIC system
Example:
VBScriptSelect and copy to clipboard

Dim nIndex, arr( 2)
arr(0) = "Sunday"
arr(1) = "Monday"
arr(2) = "Tuesday"
nIndex = Filter(arr, "Mon")   ' nIndex(0) = "Monday"
PROMOTIC 9.0.17 SCADA system documentation - MICROSYS, spol. s r.o.

Send page remarkContact responsible person
© MICROSYS, spol. s r. o.Tavičská 845/21 703 00 Ostrava-Vítkovice