Inside Macintosh: Open Transport /

Chapter 7 - Process Management / Process Management Reference

Functions / Working With System Tasks

OTCancelSystemTask

Cancels a function you have scheduled to execute at system task time.

C INTERFACE

Boolean OTCancelSystemTask(long stCookie)

C++ INTERFACES

None. C++ applications use the C interface to this function.

PARAMETERS

stCookie

A reference value that identifies the task to be canceled.

DESCRIPTION

The OTCancelSystemTask function cancels a task that was scheduled with the OTScheduleSystemTask function to run at system task time. The function returns true if the scheduling was canceled. If the function returns false, then either the function was not scheduled, or it is too late to cancel it. If the stCookie parameter value is invalid (a value of 0), the function returns false and does nothing.

SPECIAL CONSIDERATIONS

You can call this Open Transport function at interrupt time, but you must precede it by calling the OTEnterInterrupt function and you must follow it by calling the OTLeaveInterrupt function.

SEE ALSO

To create a system task, call the OTCreateSystemTask function (page 7-9).

To schedule a task for execution at system task time, call the OTScheduleSystemTask function (page 7-10).

To destroy a system task created with the OTCreateSystemTask function, call the OTDestroySystemTask function (page 7-13).

Before making this call from within an interrupt, use the OTEnterInterrupt function (page 7-19).

After you have made this call from within an an interrupt, use the OTLeaveInterrupt function (page 7-20).