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

Chapter 9 - Apple Guide API / Starting Up Apple Guide

/

AGGetStatus

Use the AGGetStatus function to determine the status of Apple Guide.

AGStatus AGGetStatus(void);

DESCRIPTION

The AGGetStatus function determines whether Apple Guide is active, sleeping, or not running by returning one of the following constants:

• kAGIsActive, if the application portion of Apple Guide is in memory and a guide file is open
• kAGIsSleeping, if the application portion of Apple Guide is in memory but no guide files are open
• kAGIsNotRunning, if the application portion of Apple Guide is not in memory

SEE ALSO

To determine whether the Apple Guide API is available, use the Gestalt Manager, as described in "Determining Whether Apple Guide Is Available" on page 9-4.