Below is a reference for the methods exposed by the ARAP.ARAPCOM object:


SetVariable

SetVariable VarName, Value

This method sets the the value of a global or pre-defined variable. "VarName" is set to "Value". "VarName" and "Value" are both of type "BSTR". An exception is raised if a script is running or an error occurs setting the variable.

GetVariable

Result = GetVariable VarName

This method gets the value of a global or pre-defined variable. "Result" (the return value) is set to the value of  "VarName", "VarName" and the return value are of type "BSTR". An exception is raised if "VarName" does not exist.

RunScript

RunScript Script, Parameters

This method starts the ARAP script "Script" with "Parameters". It returns immediately after the script starts. "Script" is the name of the script, not the file name containing it. "Script" and "Parameters" are of type "BSTR". An exception is raised if "VarName" does not exist.

StopScript

StopScript

This method requests that the currently running ARAP script stop execution. An exception is raised if a script was not running.

PauseScript

PauseScript

This method requests that the currently running ARAP script pause its execution. An exception is raised if a script was not running.

Hide

Hide

This method hides the ARAP window to the system tray.

Show

Show

This method restores the ARAP window from the system tray.

Secure

Secure

This method secures the ARAP user interface by making the menus and tool bar invisible.

Unsecure

Unsecure

This method unsecures the ARAP user interface by making the menus and tool bar visible.

GetLog

Result = GetLog Count

This method gets the contents of the Screen Log (up to "Count" lines, however the maximum number of lines that can be returned are between 450 and 500). Result is of type "BSTR". An exception is raised if the process takes longer than one second.