Appendix B: Available Scripting Functions

Max(d1, d2)
Returns the bigger of d1 and d2.
 
Min(d1, d2)
Returns the smaller of d1 and d2.
 
NewWorkbook()
Creates a new Excel workbook. Example:
Dim xlw
xlw = NewWorkbook()
 
ShowMessage(msg as String,Optional title as String)
Displays a message and title. The user can click Stop, Previous or Next. This function returns one of the following:
  • StepNext - Indicates that the user clicked Next.
  • StepPrev - Indicates that the user clicked Previous.
  • StepStop - Indicates that the user clicked Stop. This is also returned if the user closes the window.
This function is very useful in introducing a pause to allow the user to proceed with manual tasks before continuing. It also allows the user to go to a previous plan.
 
StepEnd
The return value of a plan function to specify that the entire test plan has ended.
 
StepNext
The return value of a plan function to specify that the next plan in the sequence is executed.
 
StepPrev
The return value of a plan function to specify that the previous plan in the sequence is executed.
 
StepRepeat
The return value of a plan function to specify that the current plan is to be repeated.
 
StepStop
The return value of a plan function to specify that the entire test plan should stop.
 
StepJump(function_name as String)
The return value of a plan function to specify that the plan with the given function name should be executed.
 
WriteText(s as String)
Writes the string to the window.
 
WriteLine(s as String)
Writes the string along with an end of line to the window.