KillTimer

<< Click to Display Table of Contents >>

Manual > Control Reference > Common to all controls > Common methods >

KillTimer

 

Stop the timer.

 

syntax

KillTimer(

         timerID

         )

 

Parameters

 

timerID

 

Type:

Number

 

The timer ID.

 

Return Value

 

 

Type:

Boolean

 

FALSE - Failure. TRUE - Success.

 

hmtoggle_plus1Explanation

Stops the timer. If you specify a counter value of 1 or more in SetTimer, the timer will automatically stop after it has fired the number of times specified by counter.

In this case there is no need to call KillTimer.

 

 

Supported

○

Script Action

Can be used in server script Ver2 actions

○

Browser script

Can be used in browser scripts

×

Calculation Expression Syntax

Can be used in expression syntax (e.g. bind syntax)

 

reference

 

SetTimer

KillTimer

KillAllTimer