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

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

/

AGFileGetDBType

Use the AGFileGetDBType function to determine the type of a guide file.

 OSErr AGFileGetDBType 
                     (AGFileFSSpecType *fileSpec,
                      AGFileDBType *databaseType);

fileSpec

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

databaseType

A pointer to the type of the guide file. The AGFileGetDBType functions returns, through this parameter, a value that indicates the guide file type. The guide file type is indicated by one of these constants:

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

DESCRIPTION

The AGFileGetDBType function returns, in its databaseType parameter, the type of the specified guide file.

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