The Pause option is a way to wait for a number of milliseconds before proceeding. When used with the Start Host Notification call, Pause is a powerful way to synchronize and track screen changes during transitions.
Note that to use Pause with the Start Host Notification, the FPAUSE must be active as a session setting (FPAUSE is the default).
In standard HLLAPI, any host session can satisfy a Pause, but in the FlyHLLAPI implementation, only the active session for this thread can satisfy the Pause when Start Host Notification has been called.
By connecting the Start Host Notification and Pause to the active thread, FlyHLLAPI makes it far easier to implement clean logic for screen transitions without wasteful polling. Each time the Pause is called, when Host Notification is active, the internal tracking is reset so that the next Pause requested will only return if a new screen update has occurred (or the timer has expired).
For an example, see the Start Host Notification section.
If no Start Host Notification is active, or if the IPAUSE session option is active, Pause will simply wait for the requested time before continuing--a simple Sleep call.
Data Length: The number of 1/2 second intervals to sleep for. If the Start Host Notification call has been made for this session and an update to the screen has occured to the screen since the Start Host Notification call was made, Pause will return immediately with the WHLLPSCHANGED as a return code. Otherwise, if a Start Host Notification call has been made, Pause will return either when the screen has been updated or the timer has expired.
| If no Start Host Notification has been executed (or a Stop Host Notification is the most recent use of these two functions), Pause will not return until the timer has expired. |
| Retcode: | WHLLOK: the timer has expired; WHLLPSCHANGED: A Start Host Notification is active, and the screen has been changed since the last Start Host Notification OR Pause |
