Legacy Documentclose button

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

Previous Book Contents Book Index Next

Inside Macintosh: More Macintosh Toolbox /
Chapter 3 - Help Manager / Help Manager Reference
Help Manager Routines / Determining the Size of a Help Balloon


HMBalloonPict

To get a handle to a picture before displaying it in a help balloon, use the HMBalloonPict function.

FUNCTION HMBalloonPict (aHelpMsg: HMMessageRecord; 
                        VAR coolPict: PicHandle): OSErr;
aHelpMsg
The help message for the help balloon; in this case, a picture.
coolPict
A handle to the picture that the Help Manager will use if you later choose to display the help balloon.
DESCRIPTION
The HMBalloonPict function does not display the help balloon; it returns a handle to the picture that the Help Manager will use if you later choose to display a help balloon with the specified help message.

The pictFrame field of the picture handle in the coolPict parameter contains the same rectangle as the rectangle obtained from the HMBalloonRect function. The rectangle specifies the display rectangle that surrounds the picture.

ASSEMBLY-LANGUAGE INFORMATION
The trap macro and routine selector for the HMBalloonPict function are
Trap macroSelector
_Pack14$040F

RESULT CODES
noErr0No error
paramErr-50Error in parameter list
memFullErr-108Not enough room in heap zone
SEE ALSO
The aHelpMsg parameter is of data type HMMessageRecord. "Providing Help Balloons for Dynamic Windows" beginning on page 3-69 describes the fields of this record.


Previous Book Contents Book Index Next

© Apple Computer, Inc.
6 JUL 1996