Legacy Document

Inside Macintosh: Interapplication Communication /

Chapter 10 - Scripting Components / Scripting Components Reference

Optional Scripting Component Routines / Executing Scripts in One Step

OSALoadExecute

You can use the OSALoadExecute function to load and execute a script in a single step rather than calling OSALoad and OSAExecute.

FUNCTION OSALoadExecute (scriptingComponent: ComponentInstance;
                         scriptData: AEDesc; 
                         contextID: OSAID; modeFlags: LongInt; 
                         VAR resultingScriptValueID: OSAID) 
                         : OSAError;

scriptingComponent

A component instance created by a prior call to the Component Manager function OpenDefaultComponent or OpenComponent (see page 10-4).

scriptData

The descriptor record identifying the script data to be loaded and executed.

contextID

The script ID for the context to be used during script execution. The constant kOSANullScript in this parameter indicates that the scripting component should use its default context.

modeFlags

Information used by individual scripting components. To avoid setting mode flag values, specify kOSAModeNull. Other possible mode flags are listed in the description that follows.

resultingScriptValueID

The script ID for the script value returned.

DESCRIPTION

The OSALoadExecute function loads script data and executes the resulting compiled script, using the script context identified by the contextID parameter to maintain state information such as the binding of variables. After successfully executing the script, OSALoadExecute disposes of the compiled script and returns either the script ID for the resulting script value or, if execution does not result in a value, the constant kOSANullScript.

You can control the way in which the scripting component executes a script by adding any of these flags to the modeFlags parameter:

Flag	Description
kOSAModeNeverInteract	Adds kAENeverInteract to sendMode parameter of AESend for events sent when script is executed.
kOSAModeCanInteract	Adds kAECanInteract to sendMode parameter of AESend for events sent when script is executed.
kOSAModeAlwaysInteract	Adds kAEAlwaysInteract to sendMode parameter of AESend for events sent when script is executed.
kOSAModeCantSwitchLayer	Prevents use of kAECanSwitchLayer in sendMode parameter of AESend for events sent when script is executed (the opposite of the Apple Event Manager's interpretation of the same bit).
kOSAModeDontReconnect	Adds kAEDontReconnect to sendMode parameter of AESend for events sent when script is executed.
kOSAModeDoRecord	Prevents use of kAEDontRecord in sendMode parameter of AESend for events sent when script is executed (the opposite of the Apple Event Manager's interpretation of the same bit).

If the result code returned by OSALoadExecute is a general result code, there was some problem in arranging for the script to be run. If the result code is errOSAScriptError, an error occurred during script execution. In this case, you can obtain more detailed error information by calling OSAScriptError.

RESULT CODES

noErr	0	No error
errOSACorruptData	-1702	Same as errAECorruptData
errOSASystemError	-1750	General scripting system error
errOSAInvalidID	-1751	Invalid script ID
errOSABadStorageType	-1752	Script data not for this scripting component
errOSAScriptError	-1753	Error occurred during execution
errOSADataFormatObsolete	-1758	Data format is obsolete
errOSADataFormatTooNew	-1759	Data format is too new
badComponentInstance	$80008001	Invalid component instance