VBScript Reference Manual for InduSoft Web Studio

InduSoft Web Studio VBScript Reference Manual
Array Functions & Statements
Array Functions Description
Array Returns a variant containing an array
Dim Declares variables and allocates storage space
Erase Reinitializes the elements of fixed-size arrays, deallocates dynamic-array storage space.
Filter Returns a zero-based array that contains a subset of a string array based on a filter criteria
IsArray Returns a Boolean value that indicates whether a specified variable is an array
Join Returns a string that consists of a number of substrings in an array
LBound Returns the smallest subscript for the indicated dimension of an array
ReDim Declare dynamic array variables, allocates or reallocates storage space at procedural level
Split Returns a zero-based, one-dimensional array that contains a specified number of substrings
UBound Returns the largest subscript for the indicated dimension of an array
Examples using these array functions are:
Dim MyArray(3), MyString, VarArray(), MyIndex, littleArray
MyArray(0) = “President ”
MyArray(1) = “George ”
MyArray(2) = “W. ”
MyArray(3) = “Bush”
MyString = Join(MyArray) ‘ MyString equals “President George W. Bush”
MyString = “HelloxWidexWorld”
MyArray = Split (MyString, “x”, -1,1) ‘ MyArray(0) contains “Hello”
‘ MyArray(1) contains “Wide”
‘ MyArray(2) contains “World”
MyIndex = Filter(MyArray, “W. “) ‘ MyIndex will equal 2
ReDim VarArray(10) ‘ Redimension the VarArray array
ReDim VarArray(20) ‘ Redimension the VarArray array
VarArray(19) = 19
VarArray(20) = 20
littleArray = Array(12.3.64, 15) ‘ Populate the array with the Array function
Erase VarArray ‘ Deallocates memory for the dynamic array
Erase MyArray ‘ Simply erases the fixed size array
Key Notes:
• VBScript Array indices always start with 0. This is not the case with VBA.
• An array MyArray(2) has 3 elements, with indices 0, 1, and 2.
• Multi-dimensional arrays are supported up to 60 dimensions.
• Dim MyArray() is a dynamic array, and must be sized later with the ReDim statement .
• The Preserve keyword will preserve existing elements in a dynamic array
• Erase function deallocates memory for dynamic arrays, only clears fixed size arrays
Boolean Variables
Boolean variables have one of two values; True or False. The VBScript Keywords True or False can
be used to assign a value to the boolean variable. A boolean False is stored as a 0, but the boolean
True is not stored as a 1. Since the data storage element for the boolean value is a signed 32-bit value,
a boolean True will have all bits in the 32-bit value set to 1, which is a negative signed integer value of -
1. It is best to work with the boolean values True or False when working with boolean variables.
InduSoft, Ltd. 67