Legacy Document

Inside Macintosh: Apple Guide Complete / Part 3 - Integrating Guide Files

Chapter 9 - Apple Guide API / Application-Defined Routines

Providing Object Locations for Coachmarks

MyCoachReplyProc

A coachmark handler function should find and return the rectangle for a named object. Here is the syntax of a coachmark handler function:

pascal OSErr MyCoachReplyProc
                     (Rect *pRect, Ptr name, long refCon);

pRect

An address through which your coachmark handler should return the rectangle of the object to coachmark, in global coordinates.

name

The name of the object to coachmark. The name is stored as a NULL-terminated string.

refCon

A reference constant, which your application sets when it installs the coachmark handler. Your coachmark handler can use this reference constant for any purpose.

DESCRIPTION

A coachmark reply function should return, through the pRect parameter, the global coordinates of the object to coachmark.

RESULT CODES

The MyCoachReplyProc function should return noErr if successful or an appropriate result code otherwise.

SEE ALSO

For information on installing a coachmark handler, see page 9-33.