Technical Reference Manual - InduSoft

Appendix: Built-in Scripting Language
Note: In SQL, curly brackets ({}) are typically used to enclose an expression that
must be evaluated before the entire SQL statement is executed. For example:
SELECT * INTO inmates FROM OPENROWSET
('MSDASQL','Driver={Microsoft Text Driver (*.txt;
*.csv)};DEFAULTDIR=C:\;Extensions=CSV;','SELECT * FROM
flat.csv')
In IWS, however, curly brackets are used to reference project tags in text fields
that are not normally evaluated (e.g., in the caption of a Button object). If you
pass a SQL statement that includes such an expression to DBExecute, then the
project will try to evaluate the expression as a tag reference and the function will
fail.
To pass the SQL statement so that the project can correctly evaluate the
expression, create a new string tag that contains the text of the expression and
then reference that tag in the SQL statement. For example:
AuxTag = "{Microsoft Text Driver (*.txt; *.csv)}"
DBExecute( "inmates", "SELECT * INTO inmates FROM
OPENROWSET ('MSDASQL','Driver={AuxTag};DEFAULTDIR=C:
\;Extensions=CSV;','SELECT * FROM flat.csv')")
optStrTags
A comma-delimited list of the names of array tags in your project, to which the columns of a
SQL SELECT result set will be mapped. The database values will be copied to these array tags,
with the first row of the result set being copied to array index 0. Make sure the arrays are large
enough to receive all of the rows in the result set.
This parameter is required only when strSQL contains a SQL SELECT statement. For all other
types of statements, this parameter is ignored and can be omitted. However, if you need to
maintain the syntax of the function in order to continue through to optStrErrorTag, then give
this parameter an empty string ("").
optNumMaxRows
The maximum number of rows to be copied from a SQL SELECT result set. In most cases, to
copy all of the rows, specify a number greater than the expected number of rows in the result
set.
This parameter is required only when strSQL contains a SQL SELECT statement. For all other
types of statements, this parameter is ignored and can be omitted. However, if you need to
maintain the syntax of the function in order to continue through to optStrErrorTag, then give
this parameter a value of 0.
optStrErrorTag
The name of a String tag that will receive detailed error messages, if errors occur during
runtime.
Note: The tag name must be enclosed in quotes, as shown in the syntax
diagram, or else the project will try to get the value of the named tag.
This is an optional parameter.
Returned value
This function returns the total number of rows affected by the SQL statement. If an error occurs, then it
returns a negative number.
InduSoft Web Studio Page 749