Legacy Document

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

Chapter 23 - Programming With Open Transport Reference / Functions

Working With Deferred Tasks /

OTDestroyDeferredTask

Destroys a deferred task created with the OTCreateDeferredTask function.

C INTERFACE

OSStatus OTDestroyDeferredTask(long dtCookie)

C++ INTERFACE

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

PARAMETERS

dtCookie

A reference that identifies the task to be destroyed.

function result

The function returns the result kEAGAINErr when you try to destroy the task from within an interrupt service routine or within another deferred task. If dtCookie is invalid (a value of 0), the function returns kOTNoError and does nothing.

DISCUSSION

The OTDestroyDeferredTask function makes the dtCookie reference invalid and frees any resources allocated to the task when it was created. You can call this function at any time when you no longer need to schedule the deferred task object.

SEE ALSO

The OTCreateDeferredTask function.

The OTScheduleDeferredTask function.