Legacy Document

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

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

/

AGFileGetHelpMenuAppCreator

Use the AGFileGetHelpMenuAppCreator function to retrieve the four-character value that specifies the application associated with this guide file.

 OSErr AGFileGetHelpMenuAppCreator
                     (AGFileFSSpecType *fileSpec,
                      OSType *helpMenuAppCreator);

fileSpec

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

helpMenuAppCreator

The AGFileGetHelpMenuAppCreator function returns, through this parameter, the four-character value that specifies the application associated with this guide file.

DESCRIPTION

The AGFileGetHelpMenuAppCreator function returns, through its helpMenuAppCreator parameter, the signature of the application that is associated with the guide file specified in the fileSpec parameter.

If a guide file specifies the application associated with it, then the value returned in the helpMenuAppCreator parameter must match the signature of the application for the guide file to appear in the application's Help menu. If the guide file does not specify the application that is associated with it, the helpMenuAppCreator parameter returns NIL.

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