Inheritance diagram for IUxpScriptUtils:

Public Types
enum	{ kDefaultIID = IID_IUXPSCRIPTUTILS }

Public Member Functions
virtual ErrorCode	CreateUxpScriptEngine (const PMString &engineName, bool16 isResettable, bool16 isDebuggable) const =0

virtual ErrorCode	DeleteUxpScriptEngine (const PMString &engineName) const =0

virtual ErrorCode	RunFileInEngine (const PMString &engineName, const IDFile &idFile, bool16 showErrorAlert=kTrue, bool16 invokeDebugger=kFalse) const =0

virtual ErrorCode	RunScriptInEngine (const PMString &engineName, const PMString &scriptText, bool16 showErrorAlert=kTrue, bool16 invokeDebugger=kFalse) const =0

virtual ErrorCode	RunScriptInEngine (const PMString &engineName, const ScriptData &script, const ScriptRecordData &arguments, ScriptData &result, PMString &errorString, bool16 showErrorAlert=kTrue, bool16 invokeDebugger=kFalse, const RunScriptParams::UndoMode undoMode=RunScriptParams::kUndoScriptRequest, const PMString &undoName=PMString()) const =0

virtual ErrorCode	RunScriptInEngine (const PMString &engineName, const ScriptData &script, bool16 evalStringAsFilePath, const ScriptRecordData &arguments, ScriptData &result, PMString &errorString, bool16 showErrorAlert=kTrue, bool16 invokeDebugger=kFalse, const RunScriptParams::UndoMode undoMode=RunScriptParams::kUndoScriptRequest, const PMString &undoName=PMString()) const =0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Member Function Documentation

virtual ErrorCode IUxpScriptUtils::CreateUxpScriptEngine	(	const PMString &	engineName,
		bool16	isResettable,
		bool16	isDebuggable
	)		const

pure virtual

Create a new engine, if none exists with this name

Parameters

engineName	is the name of the engine to create
isResettable	whether the engine should be reset after every script
isDebuggable	whether the engine should be visible to the ESTK IDE

Returns: kSuccess if a new engine is created, kItemWithThisNameAlreadyExistsError if an engine with this name already exists, or kFailure if no engine was created

virtual ErrorCode IUxpScriptUtils::DeleteUxpScriptEngine ( const PMString & engineName ) const

pure virtual

Delete an engine by name

Parameters

engineName is the name of the engine to delete

Returns: kSuccess if an engine with that name was found and deleted, kObjectDeletedError if no engine with that name was found, or kFailure if an engine was found but not deleted

virtual ErrorCode IUxpScriptUtils::RunFileInEngine	(	const PMString &	engineName,
		const IDFile &	idFile,
		bool16	showErrorAlert = `kTrue`,
		bool16	invokeDebugger = `kFalse`
	)		const

pure virtual

Execute a script file in a particular engine. Creates the engine if it doesn't already exist.

Parameters

engineName	is the name of the engine to use
idFile	the script file to execute IN
showErrorAlert	if an error occurs whether the runner should display an alert with the error IN
invokeDebugger	whether to load script into debugger for execution IN

virtual ErrorCode IUxpScriptUtils::RunScriptInEngine	(	const PMString &	engineName,
		const PMString &	scriptText,
		bool16	showErrorAlert = `kTrue`,
		bool16	invokeDebugger = `kFalse`
	)		const

pure virtual

Execute a script in a particular engine. Creates the engine if it doesn't already exist.

Parameters

engineName	is the name of the engine to use
scriptText	the script text to execute IN
showErrorAlert	if an error occurs whether the runner should display an alert with the error IN
invokeDebugger	whether to load script into debugger for execution IN

virtual ErrorCode IUxpScriptUtils::RunScriptInEngine	(	const PMString &	engineName,
		const ScriptData &	script,
		const ScriptRecordData &	arguments,
		ScriptData &	result,
		PMString &	errorString,
		bool16	showErrorAlert = `kTrue`,
		bool16	invokeDebugger = `kFalse`,
		const RunScriptParams::UndoMode	undoMode = `RunScriptParams::kUndoScriptRequest`,
		const PMString &	undoName = `PMString()`
	)		const

pure virtual

Execute a script in a particular engine. Creates the engine if it doesn't already exist.

Parameters

engineName	is the name of the engine to use IN
script	is the script to execute (may be a String, a File, or a Function) IN
arguments	is used to pass arguments to the script IN
result	is the return value OUT
errorString	is the error string OUT
showErrorAlert	if kTrue show an error alert if an error occurs IN
invokeDebugger	indicates whether to load script into debugger for execution IN
undoMode	indicates how to handle undo for document changes made by the script IN
undoName	is the name for the undo step in single undo step mode IN

virtual ErrorCode IUxpScriptUtils::RunScriptInEngine	(	const PMString &	engineName,
		const ScriptData &	script,
		bool16	evalStringAsFilePath,
		const ScriptRecordData &	arguments,
		ScriptData &	result,
		PMString &	errorString,
		bool16	showErrorAlert = `kTrue`,
		bool16	invokeDebugger = `kFalse`,
		const RunScriptParams::UndoMode	undoMode = `RunScriptParams::kUndoScriptRequest`,
		const PMString &	undoName = `PMString()`
	)		const

pure virtual

INTERNAL USE ONLY Execute a script in a particular engine. Creates the engine if it doesn't already exist.

Parameters

engineName	is the name of the engine to use IN
script	is the script to execute (may be a String, a File, or a Function) IN
evalStringAsFilePath	if kTrue evaluate if the script string is a file path IN
arguments	is used to pass arguments to the script IN
result	is the return value OUT
errorString	is the error string OUT
showErrorAlert	if kTrue show an error alert if an error occurs IN
invokeDebugger	indicates whether to load script into debugger for execution IN
undoMode	indicates how to handle undo for document changes made by the script IN
undoName	is the name for the undo step in single undo step mode IN

Public Types