This topic has not yet been rated - Rate this topic

Object.cancelTimeOut Method

Dynamics AX 2009

Dynamics AX 4.0

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

Copy


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.

Copy

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

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