VCOM:VectorWorks:Scripting:IPythonScriptEngine::RequestPredefinedCode

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