Window.clearTimeout() (Method)

Clear a previously established timeout function call.

Availability:

JavaScript - 1.0
JScript - 1.0
Internet Explorer - 3.02
Netscape - 2.0
Opera - 3.0
Property/method value type:undefined
JavaScript syntax:-clearTimeout(aTimeoutID)
-myWindow.clearTimeout(aTimeoutID)
Argument list:aTimeoutIDThe ID of a timeout returned by the setTimeout() method

The timeout mechanism can be used to defer the execution of a block of script code. You can defer several blocks at once if necessary, so there could be a number of pending timeout triggers. You must be able to identify the one that you want to clear.

When you create a timeout trigger with the setTimeout() method, it will return back to you with a value that corresponds uniquely to that trigger's set-up context. You can use that value later to clear the timeout trigger.

You must be careful not to clear timeout triggers more than once.

Warnings:

See also:clearTimeout(), Frame object, Timeout handlers, Timer events, Window object, Window.clearInterval(), Window.setTimeout()