[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
 SetTimeOut()
 Set and/or get the InterruptKey() timeout value.
-------------------------------------------------------------------------------

 Syntax:

     SetTimeOut( [<nNewSeconds>] ) --> <nSeconds>

 Arguments:

     <nSeconds> is the number of seconds the InterruptKey() timeout utility
     is currently using.

     <nNewSeconds> is the optional new value for the InterruptKey() timeout
     utility to use.

 Returns:

     SetTimeOut() always returns the current InterruptKey() timeout setting.

 Description:

     SetTimeOut() works with the any utility which uses InterruptKey()
     forcing it to abort when no user input has occurred for the number of
     seconds defined by SetTimeOut().  A value of 0 disables the timeout
     feature.  Default is 0.  The intent of this feature is to force abortion
     of a READ or such in a network environment where records are locked.  By
     forcing abortion after a prolonged period of inactivity the record is
     freed for use by other users.  Every mouse and keyboard event resets the
     internal counter to the number specified by SetTimeOut().

 Example:

     // set the time out 5 minutes of inactivity
     SetTimeOut( 300 )


 Files:  Library is CUACLIP.LIB.

See Also: InterruptKey()
This page created by ng2html v1.05, the Norton guide to HTML conversion utility. Written by Dave Pearson