Legacy Document

Inside Macintosh: More Macintosh Toolbox /

Chapter 3 - Help Manager / Help Manager Reference

Help Manager Routines / Determining the Size of a Help Balloon

HMGetBalloonWindow

The Help Manager displays help balloons in special windows; to get a pointer to the window record of the currently displayed help balloon, use the HMGetBalloonWindow function.

FUNCTION HMGetBalloonWindow (VAR window: WindowPtr): OSErr;

window

A pointer to the window record for the currently displayed help balloon.

DESCRIPTION

In its window parameter, HMGetBalloonWindow returns a pointer to the window record for the currently displayed help balloon. The window record contains a graphics port record, which in turn defines the port's rectangle.

If no help balloon is currently displayed, the HMGetBalloonWindow function returns NIL in the window parameter. The HMGetBalloonWindow function also returns NIL for balloons created with the HMShowMenuBalloon function because no windows are created; likewise, NIL is returned for balloons created with the HMShowBalloon function when the kHMSaveBitsNoWindow constant is specified as the method parameter.

ASSEMBLY-LANGUAGE INFORMATION

The trap macro and routine selector for the HMGetBalloonWindow function are

Trap macro	Selector
_Pack14	$0215

RESULT CODES

noErr	0	No error
memFullErr	-108	Not enough room in heap zone

SEE ALSO

The description of the HMShowMenuBalloon function begins on page 3-96; the description of the HMShowBalloon function begins on page 3-93.