VCOM:VectorWorks:Scripting:IPythonScriptEngine::ExecuteScript: Difference between revisions

From Vectorworks Developer
Jump to navigation Jump to search
m (1 revision)
No edit summary
 
Line 9: Line 9:
Member of [[VCOM:VectorWorks:Scripting:IPythonScriptEngine]]
Member of [[VCOM:VectorWorks:Scripting:IPythonScriptEngine]]


...put some description here...
Execute a python script provided as a string. This script is executed in the engine similarly to a document script.
 
More advanced script execution can be achieved by using [[VCOM:VectorWorks:Scripting:IPythonWrapper]]
</desc>
</desc>


Line 15: Line 17:
<def>
<def>
<funcDef lang="cpp">
<funcDef lang="cpp">
virtual VCOMErrorVCOM_CALLTYPE ExecuteScript(const TXString& script) = 0;
virtual VCOMError VCOM_CALLTYPE ExecuteScript(const TXString& script) = 0;
</funcDef>
</funcDef>
</def>
</def>
Line 25: Line 27:
script
script
const [[SDK:TXString]]&
const [[SDK:TXString]]&
no info.
The script text.
</line>
</line>
</lineList>
</lineList>

Latest revision as of 15:37, 19 September 2013

Description

namespace VectorWorks::Scripting

Member of VCOM:VectorWorks:Scripting:IPythonScriptEngine

Execute a python script provided as a string. This script is executed in the engine similarly to a document script.

More advanced script execution can be achieved by using VCOM:VectorWorks:Scripting:IPythonWrapper

virtual VCOMError VCOM_CALLTYPE ExecuteScript(
const TXString& script) = 0;

Parameters

script const SDK:TXString& The script text.

Return Value

Uses standard VCOM Error Reporting.

Return value meaning:

kVCOMError_NotInitialized Bad VCOM instance used to call the fuction.
kVCOMError_Failed Routine failed.

Version

Availability: from Vectorworks 2014