Variables
Previous  Top  Next

Below are a list of the built in variables available to the Main scripts.

Use the "ct" prefix to access a variable or function from the client.

For example: If ct.QuitNow = 1 then exit sub

Variables:

QuitNow As Long

If set to a value other than 0, indicates that the script must stop processing and exit immediately.

When the STOP button is pressed on the Activities page, the value of QuitNow will be set to 1 for each running thread.

Ensure that this variable is checked within any long duration loops so that the program will respond to the stop events in a timely manner.


Devices As String

Comma delimited list of devices for the clients to connect to. Example: DeviceA,DeviceB,DeviceC


ScriptFileMain As String

File name of the current script file that is being run for this activity.


ScriptFileClient As String

File name of the client script file to be run by the client threads for this activity.


ScheduleNumber As Integer

The unique identifying number of the current activity.


AppPath As String

The folder in which the main application (Kiwi CatTools) is installed. This folder is always terminated with a "\" character. Use this variable as the root path when saving data to results files. (The ClientTemp folder for example is located under the root path.)

Under construction.