0LASubrUtilTimeoutExit < Main

Tags: view all tags
---+ .UTIL TIMEOUT EXIT

_This subroutine exits the current process or logs a user off after a set timeout period._

<br /><span data-mce-mark="1">%TOC%</span>
---++ Usage:
<pre>      PASS         &lt;action&gt;                   FIELD            SHARE? N
      PASS         &lt;action_delay&gt;             FIELD            SHARE? N
      GOSUB    --- .UTIL TIMEOUT EXIT
      *        Check for errors
      IF       --- .UTIL TIMEOUT EXIT         NE

  
</pre>
---++ Description:

This subroutine exits the current process or logs a user off after a set timeout period. The &lt;action&gt; parameter is required, and the subroutine will CANCEL if it is not PASSed. The &lt;action_delay&gt; parameter is optional.

This subroutine should only be called in the Option Intercept or Global Option Intercept event points. You must have set a keyboard timeout via [[0LASubrUtilTimeoutSet][.UTIL TIMEOUT SET]] first, otherwise this routine does nothing.

&lt;action&gt; is the action that should be performed if a TIMEOUT has occurred (Required). It must be one of End or Logout. If it is End and the timeout has occurred, the current process will END. If it is Logout and the timeout has occurred, then the user will be logged out.

You may want to use Logout on Menus, and End on input processes. Thus, an unattended session at an Input process will first return to the menu, then log the user off.

&lt;action_delay&gt; is an optional parameter that represents the number of minutes before the action is taken. If this parameter is PASSed, then a message will be displayed to the user advising them how much time is left before the program exits. If there is no further activity, then the &lt;action&gt; will be taken when &lt;action_delay&gt; minutes has expired.

Note: If you use &lt;action_delay&gt; then:

   * After the warning, the &lt;action_delay&gt; becomes the new timeout.
   * Prior to 5.4.5 the warning only appears once. If the user does something to reset the timer after the warning has appeared, the next time the timer expires the specified &lt;action&gt; will be taken immediately. After 5.4.5, the warning will be repeated as required.

---++ Comments:

_Read what other users have said about this page or add your own comments._

<br /><span data-mce-mark="1">%COMMENT%</span>

-- Main.JeanNeron - 2012-01-31
Topic revision: r2 - 2016-09-30 - JeanNeron