Legacy Documentclose button

Important: The information in this document is obsolete and should not be used for new development.

Previous Book Contents Book Index Next

Inside Macintosh: Apple Guide Complete / Part 3 - Integrating Guide Files
Chapter 9 - Apple Guide API / Starting Up Apple Guide
/

AGQuit

Use the AGQuit function to quit Apple Guide.

AGErr AGQuit(void);
DESCRIPTION
The AGQuit function checks to see if any guide files are open. If it finds one open, it does not quit Apple Guide. If no guide files are open, it quits the application portion of Apple Guide.

If your application opens a guide file, it should always close the guide file and call AGQuit before quitting. Otherwise, if the application portion of Apple Guide is active or sleeping, it remains in memory.

SPECIAL CONSIDERATIONS
Don't force Apple Guide to quit when your application goes to the background. If your application has opened a guide file and the user switches to another application, your guide file should remain open until the user closes it, opens another guide file, or quits your application.

RESULT CODES
noErr0No error
kAGErrDatabaseOpen-2961No open guide file
Previous Book Contents Book Index Next

© Apple Computer, Inc.
12 JUL 1996