Legacy Document

Important: The information in this document is obsolete and should not be used for new development.

Inside Macintosh: Networking With Open Transport / Part 2 - Open Transport Reference

Chapter 23 - Programming With Open Transport Reference / Functions

OTCancelTimerTask
Cancels a task that was already scheduled for execution.

C INTERFACE
pascal Boolean OTCancelTimerTask(long timerTask);
C++ INTERFACE
None. C++ applications use the C interface to this function.

PARAMETERS

timerTask
A 32-bit value identifying the task you want to cancel. This is the value you passed to OTScheduleTimerTask when you scheduled the task.
function result
The result is true if the timer task was cancelled.

DISCUSSION
The OTCancelTimerTask cancels the execution of a task scheduled with the OTScheduleTimerTask function.

SEE ALSO
The OTScheduleTimerTask function.
The OTDestroyTimerTask function.