getTimerStatusForIF

getTimerStatusForIF(eventTag:      Integer;
                    option:        Integer output;
                    timeRemaining: Integer output;
                    interface:     JadeInterface): Boolean;

The getTimerStatusForIF method of the Object class is a variation of the getTimerStatus method for the corresponding parameters.

The getTimerStatusForIF method determines if a specific timer event started using the beginTimerForIF method is currently active.

The timer is identified by the values of the eventTag and interface parameters.

The eventTag parameter is the user-specified literal or constant value that was passed to the beginTimerForIF method to identify a specific timer event.

If the specified timer is active, this method returns true and updates the usage output parameter values listed in the following table.

Parameter	Description
option	The value that was specified in the option parameter of the beginTimerForIF method (that is, the TimerDurations category Timer_Continuous or Timer_OneShot global constant)
timeRemaining	Number of milliseconds remaining until the specified timer expires

If the specified timer is not active, this method returns false. As each timer registration is unique to the process that armed the timer, the getTimerStatusForIF method returns only the status of timers armed by the calling process.