Checks system inactivity time.

Returns the time elapsed from the last keystroke or mouse click received by Magic xpa, in tenths of a second. The Idle time depends on the Keyboard idle seconds setting in the Environment dialog box. The Idle function will only return a value if the number of seconds specified by the Environment keyboard idle seconds parameter has elapsed. The result of the Idle function is cumulative in keyboard idle tenth-seconds units.

Returns:

0, if less than keyboard Idle tenth-seconds have elapsed since the last keystroke or mouse click. A cumulative number in keyboard Idle tenth-seconds units if more than keyboard Idle tenth-seconds have elapsed since the last keystroke or mouse click.

See also:

The Online and Rich Client Samples projects (program TF04 and RTF04)