Legacy Document

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

Chapter 9 - Apple Guide API / Working With Open Guide Files

/

AGGetFSSpec

Use the AGGetFSSpec function to access the file system specification record of an open guide file.

AGErr AGGetFSSpec(AGRefNum refNum, FSSpec *fileSpec);

refNum

The reference number for a guide file or the constant kAGFrontDatabase to specify the active guide file.

fileSpec

A pointer to a file system specification record. The AGGetFSSpec function returns, through this parameter, the guide file's file system specification record.

DESCRIPTION

The AGGetFSSpec function returns (through the fileSpec parameter) the file system specification record for the guide file specified in the refNum parameter.

RESULT CODES

noErr	0	No error
kAGErrDatabaseNotOpen	-2957	Guide file is not open

SEE ALSO

To get the file system specification record for any guide file, use the AGFileGetIndDB function, as described on page 9-10.