Object.cancelTimeOut Method

Cancels a previous method call to the Object.setTimeOut Method.

public void cancelTimeOut(int timerHandle)

Run On

Called

Parameters

Parameter

Description

timerHandle

The handle of the scheduled event to delete. The handle is the value returned by Object.setTimeOut.

Remarks

Any scheduled time-out calls that have not yet been processed are automatically deleted when the object itself is deleted.

Example

The following example calls the Object.setTimeOut method, and then cancels the time-out.

void Object_cancelTimeOut(Args _args)
{
    int th; // timerHandle.
    ;

    // timedMethod is a worker method.
    th = setTimeOut( "timedMethod", 2000 );
    //....
    // Remove timeOut later.
    CancelTimeOut(th);
}

See Also

Object Class

Object.setTimeOut Method