Legacy Document

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

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

/

AGIsDatabaseOpen

Use the AGIsDatabaseOpen function to verify that a guide file is still open.

Boolean AGIsDatabaseOpen(AGRefNum refNum);

refNum

The reference number for the guide file.

DESCRIPTION

If the guide file (specified in the refNum parameter) is open, AGIsDatabaseOpen returns TRUE, and if the guide file is closed, AGIsDatabaseOpen returns FALSE.

The user or another application can close a guide file that your application explicitly opens. A user can directly close your guide file by clicking in its close box. The user or another application can indirectly close your guide file by opening another guide file. (Before opening a guide file, Apple Guide closes the active guide file, if any.) Therefore, when your application switches from the background to the foreground, you should call AGIsDatabaseOpen to verify that your guide file is still open.

SEE ALSO

You can also verify that a guide file is open by using the function AGGetFrontWindowKind function. The AGGetFrontWindowKind function (described next) returns additional information about a guide file.