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 / Opening and Closing Guide Files
/


AGOpen

Use the AGOpen function to open a guide file in its default active list. You can use this function to open any guide file.

AGErr AGOpen(FSSpec *fileSpec, UInt32 flags,
             Handle mixinControl,
             AGRefNum *resultRefNum);
fileSpec
A pointer to the file system specification record of the guide file you wish to open. Specify NIL to open the first guide file of type Help that is available to the application.
flags
Reserved. Specify 0 in this parameter.
mixinControl
Reserved. Specify NIL in this parameter.
resultRefNum
An address through which AGOpen returns a reference number for the guide file specified in the fileSpec parameter. You use this reference number to refer to the guide file in other Apple Guide functions.
DESCRIPTION
The AGOpen function opens the guide file specified in the fileSpec parameter. It opens the guide file in its default active list. (For a Full Access window, Topics, Index, Look For, or Howdy; for a Single List Access window, Topics or Howdy; for a Simple access window, the first panel of its sequence.) If the application portion of Apple Guide is not in memory, AGOpen calls AGStart to start up Apple Guide before it opens the specified guide file.

RESULT CODES
noErr0No error
kAGErrCannotOpenAliasFile-2954Unable to open alias
kAGErrDatabaseNotAvailable-2956Guide file is not available
kAGErrInsufficientMemory-2962Not enough memory
SEE ALSO
For a description of the AGStart function, see page 9-5.


Previous Book Contents Book Index Next

© Apple Computer, Inc.
12 JUL 1996