View source for $WakeUp

{{DISPLAYTITLE:$WakeUp}}
<span class="pageSubtitle">Pause user until specified time</span>

<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $WakeUp function.</p>

This function can be used to have the user pause until a particular time. The chief advantages of $WakeUp over the PAUSE statement are

<ul>
<li>You can wake up at a particular time rather than after a particular number of seconds have passed. 
<li>$WakeUp has millisecond resolution versus the second resolution of the PAUSE statement. 
<li>$WakeUp allows the wait time to not be counted toward RQTM. This is useful in cases where the pause is simply a standard part of processing rather than a pause to allow some condition to clear. 
<li>$WakeUp will allow a user to break in with a terminal interrupt on VTAM full screen terminals.
</ul>

The $WakeUp function accepts three arguments and returns a number that is the number of milliseconds since the online was brought up. As of <var class="product">[[Sirius Mods]]</var> Version 6.8, it is a callable $function . 

The first argument is a number indicating the time to wake up expressed as milliseconds since the online was brought up. 

The second argument is a number, which if present and non-zero, indicates that the wait time is not to be included as part of RQTM. 

The third argument is an optional string (<tt>NOURGMSG</tt>, case unimportant) that prevents a user paused by $WakeUp from being immediately wakened if a BROADCAST URGENT message is sent. 

The third argument is available as of <var class="product">[[Sirius Mods]]</var> Version 7.2. Prior to <var class="product">[[Sirius Mods]]</var> 7.2, $WakeUp completes immediately if a BROADCAST URGENT message is sent to the user. The functionality of this argument is also available (though not controlled by an argument) via zap in <var class="product">[[Sirius Mods]]</var> 6.7 and 7.1, as described in the <var class="product">[[Sirius Mods]]</var> Release Notes for those versions.

==Syntax==
<p class="syntax"><section begin="syntax" />[%TIME =] $WakeUp(wake_time, rqtm_flag, [option])
<section end="syntax" /></p>
<p>
</p>
<p class="caption">%TIME is a positive integer.</p>

In the following code fragment, three screens are automatically displayed for 2.3 seconds each. The sleep time is not counted toward RQTM.

<p class="code"> %TIME = $WakeUp(0)
 %RC = $FakeEnt
 READ SCREEN SCREEN1
 %TIME = $WakeUp( %TIME + 2300, 1)
 
 %RC = $FakeEnt
 READ SCREEN SCREEN2
 %TIME = $WakeUp( %TIME + 2300, 1)
 
 %RC = $FakeEnt
 READ SCREEN SCREEN3
 %TIME = $WakeUp( %TIME + 2300, 1)
 
</p>

<h2>Products authorizing {{PAGENAMEE}}</h2><ul class="smallAndTightList">
<li>[[Sirius $Functions]]
</ul>
<p>
</p>

[[Category:$Functions|$WakeUp]]