Legacy Document

Inside Macintosh: Apple Guide Complete / Part 4 - Scripting Guide Files

Chapter 10 - Guide Script Command Reference / Guide Script Command Descriptions

/ Specifying Startup Information

<Gestalt>

You can use the <Gestalt> command to define the conditions Apple Guide uses to determine whether your guide file can run and therefore whether your guide file should be added to the Help menu.

<Gestalt> selector, requiredValue 

selector

A four-character code representing a gestalt selector code.

requiredValue

A value that indicates whether your guide file should run. If this value matches the value returned by the Gestalt function in its response parameter, Apple Guide includes your guide file as an item in the Help menu. If this value does not match and if other <Gestalt> commands also do not match, Apple Guide does not include your guide file as an item in the Help menu.

DESCRIPTION

Before adding your guide file to the Help menu, Apple Guide calls the Gestalt function with the selector code specified by a <Gestalt> command and checks the response parameter against the value specified by the requiredValue parameter. If these values match (and if the creator specified by the <App Creator> command also matches), Apple Guide adds your guide file to the Help menu. You can specify additional <Gestalt> commands. If you do, Apple Guide performs an OR operation on any conditions specified by <Gestalt> commands in your guide file. If any one of the specified conditions is true, Apple Guide adds your guide file to the menu. If none of the conditions are true, Apple Guide does not add your guide file to the Help menu.

SPECIAL CONSIDERATIONS

You can specify up to three <Gestalt> commands in your help source files.

EXAMPLES

#specify conditions that must be true to run this guide 
# file; if any of these are true, then add this guide file
#the Gestalt selector 'snd ' returns attributes related to
# sound and a value of 16 indicates a sound input device 
# is present
<Gestalt> 'snd ', 16
#specify conditions related to sound input & speech mgr
<Gestalt> 'snd ', 16
<Gestalt> 'ttsc', 0

SEE ALSO

For a complete list of Gestalt selector codes, see the chapter "Gestalt Manager" in Inside Macintosh: Operating System Utilities.