Legacy Document

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

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

/

AGFileGetDBCount

Use the AGFileGetDBCount function to count the number of guide files in a specified folder.

AGFileCountType  AGFileGetDBCount
                  (short vRefNum, long dirID,
                   AGFileDBType databaseType,
                   Boolean wantMixin);

vrRefNum

The volume reference of the volume on which the guide file is located.

dirID

The directory ID of the directory where the guide file is located.

databaseType

The guide file type. Use these constants to specify the type of guide file:

           enum {
            kAGFileDBTypeAny        = 0,/*all types*/
            kAGFileDBTypeHelp       = 1,/*Help*/
            kAGFileDBTypeTutorial   = 2,/*Tutorial*/
            kAGFileDBTypeShortcuts  = 3,/*Shortcuts*/
            kAGFileDBTypeAbout      = 4,/*About*/
            kAGFileDBTypeOther      = 8 /*Other*/
           };

wantMixin

A flag. Set to TRUE if you want to count the number of main guide files and Mixin guide files. Set to FALSE if you want to count only the number of main guide files.

DESCRIPTION

The AGFileGetDBCount function returns the number of guide files available in the folder specified by the vrRefNum and dirID parameters. This function counts only the guide files of the type specified in the databaseType parameter.