Reviewed and revised December 2023
tab(-10, AG_IATIMEOUT); opcode, timesecs; chr(127); Tab(-10,x) Syntax Notes
AG_IATIMEOUT (79) retrieves or sets the inactivity timeout period.
This function has both a subroutine and a print tab implementation.
Parameters
opcode should be 1 (MXOP_SET) to set the timeout, and 1 (MXOP_gET) to retrieve it (in seconds). Since the default opcode is 0 (MXOP_get) and the timesecs argument is ignored in the case of the retrieve operation, both arguments can be eliminated when retrieving the timeout.
Response
For opcode 0, the current inactivity timeout value in seconds:
timesecs <CR>
Note that this differs from the IATIMEOUT parameter in the system ini file, which uses units of minutes.
Examples
Retrieve:
? tab(-10,AG_IATIMEOUT);chr(127);
input "",timeout'seconds
Set:
? tab(-10,AG_TIMEOUT);"1,";timeout'seconds;chr(127);
Comments
Also see IATIMEOUT in the system ini file and MX_IATIMEOUT. Note that in the case of ATE, if the server-side timeout expires, the job will receive error 254, whereas if the client-side timeout expires, the job will experience this as a hang-up (error 250). See Job Terminations for more details on how hang-ups are handled.
See Also
History
2011 June, A-Shell 5.1.1221: Command added to A-Shell
