Legacy Document

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

Chapter 9 - Apple Guide API / Determining Which Guide Files Are Available

/

AGGetAvailableDBTypes

Use the AGGetAvailableDBTypes function to determine the types of guide files that are available in the current application's Help menu.

UInt32 AGGetAvailableDBTypes(void);

DESCRIPTION

The AGGetAvailableDBTypes function returns a collection of bit flags that indicate the types of guide files that are available in the current application's Help menu:

enum AGDBTypeBit
{
   kAGDBBitAny          = 0x00000001,/*one or more guide */
                                     /* files are present*/
   kAGDBTypeBitHelp     = 0x00000002,/*Help guide file*/
   kAGDBTypeBitTutorial              /*Tutorial guide */
                        = 0x00000004,/* file*/
   kAGDBTypeBitShortcuts             /*Shortcuts guide */
                        = 0x00000008,/* file*/
   kAGDBTypeBitAbout    = 0x00000010,/*About guide file*/
   kAGDBTypeBitOther    = 0x00000080/*Other guide file*/
};

The AGGetAvailableDBTypes function returns

• kAGDBBitAny if one or more guide files are present
• kAGDBTypeBitHelp if a Help guide file is present
• kAGDBTypeBitTutorial if a Tutorial guide file is present
• kAGDBTypeBitShortcuts if a Shortcuts guide file is present
• kAGDBTypeBitAbout if an About guide file is present
• kAGDBTypeBitOther if an Other guide file is present
• 0 if no guide files are present

SEE ALSO

To count the number of guide files of a particular type, use the AGFileGetDBCount function, described next. To get the file system specification record for a guide file, use the AGFileGetIndDB function, as described on page 9-10.