Legacy Document

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

Inside Macintosh: Cyberdog Programmer's Kit / Part 3 - Cyberdog Reference

Chapter 6 - Types, Constants, and Global Functions / Programmer-Defined Functions

MyAbortFunction
Implements the abort behavior for a progress broadcaster.
void MyAbortFunction (CDAbortProcMessage msgCode,
CyberProgressBroadcaster* broadcaster,
Ptr userDataPtr);
msgCode
A message code that indicates that the progress broadcaster is being aborted.
broadcaster
A pointer to the progress broadcaster object that is being aborted.
userDataPtr
A pointer to data that may be useful when aborting the progress broadcaster.

DISCUSSION
The purpose of your abort function is to implement any behavior that you want to perform when a progress broadcaster's Abort method is called. The Abort method calls the abort function, which you register when you call CyberProgressBroadcaster::ICyberProgressBroadcaster. This mechanism allows you to customize the abort behavior of a progress broadcaster object without having to subclass CyberProgressBroadcaster.
The userDataPtr parameter contains a pointer to data that may be useful when aborting the progress broadcaster. For example, this parameter might point to a display part whose progress broadcaster should be deleted.

SEE ALSO
The CyberProgressBroadcaster::Abort method (page 300).
The CyberProgressBroadcaster::ICyberProgressBroadcaster method (page 307).