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

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

/

AGFileGetDBMenuName

Use the AGFileGetDBMenuName function to obtain, for a specific guide file, the text that Apple Guide displays in an application's Help menu when the guide file is available.

OSErr AGFileGetDBMenuName 
                  (AGFileFSSpecType *fileSpec,
                   AGFileDBMenuNamePtr menuItemNameStr);

fileSpec

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

menuItemNameStr

A pointer to a text string. The AGFileGetDBMenuName function returns, through this parameter, the guide file's Help menu name.

DESCRIPTION

The AGFileGetDBMenuName function returns, in the menuItemNameStr parameter, the guide file's Help menu name.

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