Skip to main content

Script Methods and Properties

The Query and Working Query objects support the following methods and properties.

Supported Methods

MethodsDescription
ExecuteExecutes the object query. Use this to perform the query after setting the source, path, and properties.
ResetResets the object’s properties to their original values. Use this if the source, path, or properties have been modified, but the original values are desired.
AddProperty (attributes : string)Adds a property to the query. Using the following format: NAME=<value>;COLUMN=<value>;VALUE=<reserved>;DATATYPE=<datatype>;SIZE=<value>;KEY=<value>
DeleteProperty (propertyname : string)Removes a property from a query.

Supported Properties

PpropertiesDescription
Host : stringSets or retrieves the current host
Source : stringSets or retrieves the data source
Path : stingSets or retrieves the path
Paths : integerSets or retrieves the current path for multi-path tasks
ResultData (Property : string) : VariantSets or retrieves the value for the property specified
ResultData (PropertyIndex : integer) : VariantSets ResultRow to the desired row before accessing this property
ResultRow : integerSets or retrieves the current row. For non-enumerated tasks, ResultRow will always be 0.
ResultRows : integerSets or returns the count of rows. Use this to determine the number of rows returned after an enumerated task is executed. Set this property to create a multi-row return value.
Message (index : integer, type : string)Sets or returns a message in the indicated position. Use MessageCount to determine the number of messages. These messages appear in the job MessageLog.