VSSON 'TIMEOUT'

Edit online

Determines the action to be taken when a virtual session timeout occurs.

Type

CL/SuperSession function

Format

VSSON('TIMEOUT' session [dialog])
session
The session that the action is performed on; this can be a 1- to 8-character session ID or wildcard characters (*, /, or ?) to select multiple sessions.
dialog
The name of a dialog to run when a timeout occurs.

Return Codes

0
VSSON'TIMEOUT' completed successfully.
4
VSSENTRY was not issued first.
8
session was not found.
12
Invalid function call.

Usage Notes®

  1. You must specify a session.
  2. The dialog parameter is optional. If you omit this parameter, no dialog runs when the timeout occurs and the session terminates.
  3. If you specify a dialog, it is run asynchronously; therefore, you must issue VSSENTRY in the called dialog if other CL/SuperSession functions are required, that is, VSSENTRY(" ").
  4. VSSON 'TIMEOUT' must be reissued each time a timeout event is triggered.
  5. The specified dialog cannot contain a VSSTERM function if there is a TERMDLG dialog coded on the APPLDEF command or VSSALLOC, VSSFOREG, or VSSLOGON functions.
  6. Presentation Space Manager (PSM) services are not available to the called dialog.
  7. This function is the virtual session equivalent of the ON 'TIMEOUT' function.
  8. A virtual session timeout is specified by the VSSTIMOT function.
  9. If the TIMEOUT pop-up dialog is designed to save the contents of the physical screen and passes them to the application, a )BODY statement must be included in the pop-up dialog. (See the Example below.)

Example

In the following example, TSO is the application that times out and the TIMEOUT dialog name is tlwarm. A simulated PF3 key is issued to TSO to save the data that has been typed but not entered on the physical terminal screen under TSO EDIT.

)option popup level(1)
)body

< Session Timeout in Process "

)epilogue
WAIT(2)
vssentry('' '')
vsskey(TSO 'PF3')            /* save the data */
vsstimot(TSO 00:00:30)       /* reset the timer */
vsson('TIMEOUT' TSO tlwarm)  /*reset the dialog name */

See Also

VSSTIMOT