HMSetBalloons

Enable or disable help

#include <Balloons.h> Help Manager

Boolean flag ; TRUE = help is currently enabled

You can enable or disable help using the HMSetBalloons function. If

you enable or disable help, you do so for all applications. The setting of

Balloon Help on-line assistance should be under the user's control. In

most cases, you should not modify the setting chosen by the user. If you

must modify this setting, return it to its previous state as soon as

possible.

flag specifies whether help should be enabled or disabled for all

applications and the system software. If the flag parameter is TRUE,

help is enabled. If the flag parameter is FALSE, help is disabled and,

if a help balloon is showing, you must first remove it using the

Returns: an operating system Error Code.

noErr (0) No error

paramErr (-50) Error in parameter list

memFullErr (-108) Not enough room in heap zone

resNotFound (-192) Unable to read resource

Notes: When help is disabled, the Help Manager does not display help balloons

for any applications. When help is disabled, the HMShowBalloon and

HMShowMenuBalloon functions do not display help balloons and return

a nonzero result code.

If help is not enabled, most Help Manager routines do nothing and return

the hmHelpDisabled result code.

The user turns Balloon Help assistance on by choosing Show Balloons

from the Help menu. You can use the HMGetBalloons function to

determine whether help is currently enabled. If you display your own help

balloons using the HMShowBalloon function, you should use the

HMGetBalloons function to determine whether help is enabled before

displaying a help balloon. If help is not enabled, you cannot display any help

balloons.

Referenced by (2):