Important: The information in this document is obsolete and should not be used for new development.
OTCancelSystemTask
Cancels a system task that you have scheduled.C INTERFACE
Boolean OTCancelSystemTask(long stCookie)C++ INTERFACE
None. C++ applications use the C interface to this function.PARAMETERS
stCookie
- A reference value that identifies the task to be canceled.
- function result
A result of
true
means that the scheduling was canceled. If the function returnsfalse
, then either the function was not scheduled, or it was too late to cancel it. If thestCookie
parameter value is invalid (a value of 0), the function returnsfalse
and does nothing.DISCUSSION
TheOTCancelSystemTask
function cancels a task that was scheduled with theOTScheduleSystemTask
function to run at system task time.SPECIAL CONSIDERATIONS
You can call this Open Transport function a thardware interrupt time, but you must precede it by calling theOTEnterInterrupt
function, and you must follow it by calling theOTLeaveInterrupt
function.SEE ALSO
TheOTCreateSystemTask
function.The
OTScheduleSystemTask
function.The
OTDestroySystemTask
function.The
OTEnterInterrupt
function.The
OTLeaveInterrupt
function.