Legacy Document

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

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

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

AGGetFrontWindowKind
Use the AGGetFrontWindowKind function to determine, for a specified open guide file, the type of window that is currently being displayed.
AGWindowKind AGGetFrontWindowKind(AGRefNum refNum);
refNum
A reference number for a guide file or the constant kAGFrontDatabase to specify the active guide file.

DESCRIPTION
The AGGetFrontWindowKind function returns information indicating whether the access window or a presentation window of the specified guide file is currently showing. It also indicates whether the guide file is open.
The AGGetFrontWindowKind function returns

kAGAccessWindow if the guide file's access window is showing
kAGPresentationWindow if a presentation window (panel) of the guide file is showing
kAGNoWindow if the specified guide file is not open (which indicates that the application portion of Apple Guide is either sleeping or not running)

Shop the Apple Online Store (1-800-MY-APPLE), visit an Apple Retail Store, or find a reseller.