VCOM:VectorWorks:Scripting:IPythonScriptEngine::RequestPredefinedCode: Difference between revisions
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]] | ||
. | Show user interface to get a predefined code. See remarks for available predefines. | ||
</desc> | </desc> | ||
| Line 25: | Line 25: | ||
predefinedCodeType | predefinedCodeType | ||
EPredefinedCodeRequest | EPredefinedCodeRequest | ||
Type of the predefined code. See remarks for more details. | |||
</line> | </line> | ||
<line> | <line> | ||
outCode | outCode | ||
[[SDK:TXString]]& | [[SDK:TXString]]& | ||
Output text with the code. | |||
</line> | </line> | ||
</lineList> | </lineList> | ||
| Line 54: | Line 54: | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<remark> | <remark> | ||
Available predefined code types: | |||
<code lang="cpp"> | |||
enum EPredefinedCodeRequest { | |||
ePredefinedCodeRequest_Procedure, | |||
ePredefinedCodeRequest_Criteria, | |||
ePredefinedCodeRequest_ToolAttribute, | |||
ePredefinedCodeRequest_Parameter, | |||
ePredefinedCodeRequest_File | |||
}; | |||
</code> | |||
</remark> | </remark> | ||
Latest revision as of 15:39, 19 September 2013
Description
namespace VectorWorks::Scripting
Member of VCOM:VectorWorks:Scripting:IPythonScriptEngine
Show user interface to get a predefined code. See remarks for available predefines.
virtual VCOMErrorVCOM_CALLTYPE RequestPredefinedCode(
EPredefinedCodeRequest predefinedCodeType,
TXString& outCode) = 0;
Parameters
predefinedCodeType EPredefinedCodeRequest Type of the predefined code. See remarks for more details. outCode SDK:TXString& Output text with the code.
Return Value
Uses standard VCOM Error Reporting.
Return value meaning:
kVCOMError_NotInitialized Bad VCOM instance used to call the fuction. kVCOMError_Failed Routine failed.
Remarks
Available predefined code types:
enum EPredefinedCodeRequest {
ePredefinedCodeRequest_Procedure,
ePredefinedCodeRequest_Criteria,
ePredefinedCodeRequest_ToolAttribute,
ePredefinedCodeRequest_Parameter,
ePredefinedCodeRequest_File
};
Version
Availability: from Vectorworks 2014