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

Chapter 9 - Apple Guide API / Opening and Closing Guide Files

/

AGOpenWithSequence

Use the AGOpenWithSequence function to open a guide file and immediately display a panel sequence. You can use this function to open any guide file.

AGErr AGOpenWithSequence(FSSpec *fileSpec, UInt32 flags,
                          Handle mixinControl,
                          short sequenceID,
                          AGRefNum *resultRefNum);

fileSpec

A pointer to the file system specification record for 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.

sequenceID

The sequence ID of the sequence to display. Guide Maker assigns sequence IDs to sequences when it compiles a guide file. You can obtain a list of all the sequence IDs in a guide file, by generating a Names to IDs report. For more information on how to generate a Names to IDs report, see the chapter "Testing Your Guide File" in Part 2.

resultRefNum

An address through which AGOpenWithSequence 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 AGOpenWithSequence function opens the guide file specified in the fileSpec parameter and immediately displays the first panel of the sequence specified in the sequenceID parameter. If the application portion of Apple Guide is not in memory, AGOpenWithSequence first calls AGStart to start up Apple Guide before it opens the specified guide file.

RESULT CODES

noErr	0	No error
kAGErrCannotOpenAliasFile	-2954	Unable to open alias
kAGErrNoAliasResource	-2955	Unable to open resource alias
kAGErrDatabaseNotAvailable	-2956	Guide file is not available
kAGErrInsufficientMemory	-2962	Not enough memory