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

Chapter 9 - Apple Guide API / Getting Information About Guide Files

/

AGFileGetHelpBalloonText

Use the AGFileGetHelpBalloonText function to obtain the help balloon text associated with a guide file.

OSErr AGFileGetHelpBalloonText
                     (AGFileFSSpecType *fileSpec,
                      Str255 helpMenuBalloonString);

fileSpec

A pointer to the file system specification record for the guide file.

helpMenuBalloonString

A text string. The AGFileGetHelpBalloonText function returns, in this parameter, the help balloon text for the guide file.

DESCRIPTION

The AGFileGetHelpBalloonText function returns, in its helpMenuBalloonString parameter, the help balloon text associated with the guide file. Apple Guide displays this text in a help balloon when Balloon Help is on and the cursor is in the guide file's menu item in the Help menu.

RESULT CODES

noErr	0	No error
nsvErr	-35	Volume doesn't exist
ioErr	-36	I/O error
fnOpnErr	-38	File not open
fnfErr	-43	File or directory does not exist
fLckdErr	-45	File is locked
rfNumErr	-51	Bad reference number
dirNFErr	-120	Directory not found or incomplete pathname
afpAccessDenied	-5000	User does not have the correct access to the file