MM Developer's Guide
MM Interfaces | MM Methods | MM Types and Misc API

IMoaMmXScript

Interface ID: IID_IMoaDrXScript
Pointer type: PIMoaMmXScript
Inheritance: IMoaUnknown
Header file: mmixscrp.h

Description

IMoaMmXScript is the interface for Scripting Xtras. Scripting Xtras provide the mechanism for defining scripting language features to extend Lingo in Director. There is only one method in this interface, Call(). The Multimedia Developer's Guide provides more on implementing scripting Xtras.

Methods

Call()

Call()

Syntax

Call(PIMoaMmXScriptThis,

PMoaDrCallInfocallPtr)

Parameters

This

Pointer to the IMoaMmXScript interface

callPtr

PMoaDrCallInfoPointer to a MoaMmCallInfo structure

Returns

kMoaErr_NoErr	Method call successful
kMoaMmErr_ArgOutOfRange	Method selector out of range
kMoaErr_OutOfMem	Method call failed due to memory error
kMoaMmErr_InternalError	Method call failed due to internal error
kMoaMmErr_ValueTypeMismatch	Value supplied for "any"-type argument not supported

Description

Performs the call specified by the Scripting Xtra. Use the methodSelector member of the callPtr structure to determine the Scripting command being called.

The MoaMmCallInfo structure callPtr contains information about the method being called and the arguments supplied with the call. Scripting Xtras implement this method with a case statement based on the methodSelector field of the call info structure, each case being the C-enumeration name of one of the handlers implemented. The code within the case represents the Xtras response to that particular handler.