SetIdleEventRate

int SetIdleEventRate (int interval);

Purpose

Sets the interval between idle events that the main callback receives.

You process idle events in the main callback function you install through InstallMainCallback.

Note   Idle events are not generated when a panel is moved or sized.

Parameters

Input
Name Type Description
interval integer Specifies the wait interval between idle events, in milliseconds.

A value of zero causes idle events to occur at the fastest possible rate.

For nonzero values, the resolution of idle events is the resolution of the system timer, plus any operating system latency. The resolution of the system timer is generally 1 ms.

Return Value

Name Type Description
status integer Return value indicating whether the function was successful. A negative number indicates that an error occurred.

Code Error Message String
xx Success