TSTool / Command / Wait
Overview
The Wait
command waits a specified time before continuing. Examples of use include:
- Testing to simulate slow datastores or long processes.
- Waiting for an external process to finish. Functionality will be added in the future to wait for a file to exist or not exist.
The TSTool Run / Cancel Command Processing (interrupt processing) menu will initiate an interrupt on the processor.
Because the Wait
command uses an internal wait,
such interrupts are treated differently than interrupting other commands and may generate warnings that have obscure wording.
This case will be evaluated and enhanced over time.
In most cases users will not need to interrupt command workflows that are using Wait
.
Command Editor
The following dialog is used to edit the command and illustrates the command syntax.
Wait
Command Editor Showing Conditions Test (see also the full-size image)
Command Syntax
The command syntax is as follows:
Wait(Parameter="Value",...)
Command Parameters
Parameter | Description | Default |
---|---|---|
WaitTime required |
The number of seconds to wait, can be specified using ${Property} . Can specify as a decimal with minimum value of .001 (1 ms). |
None – must be specified. |
ProgressIncrement |
The number of seconds between progress updates in the main TSTool progress indicator, can be specified using ${Property} . Can be specified as a decimal. |
WaitTime divided by ten. |
Examples
See the automated tests.
Troubleshooting
See Also
Exit
command