VCOM:VectorWorks:Scripting:IPythonScriptEngine::Repository GetValue: Difference between revisions
m (1 revision) |
No edit summary |
||
(One intermediate revision by the same user not shown) | |||
Line 9: | Line 9: | ||
Member of [[VCOM:VectorWorks:Scripting:IPythonScriptEngine]] | Member of [[VCOM:VectorWorks:Scripting:IPythonScriptEngine]] | ||
.. | One of the functions allowing access to data repository inside the script engine. You can use this repository from within the Script and thus have a way to communicate data in and out the Script. | ||
The following scripting functions are available to access the repository: | |||
[[VS:Rpstr_RemoveValues]] | |||
| [[VS:Rpstr_RemoveValue]] | |||
| [[VS:Rpstr_GetValueBool]] | |||
| [[VS:Rpstr_SetValueBool]] | |||
| [[VS:Rpstr_GetValueInt]] | |||
| [[VS:Rpstr_SetValueInt]] | |||
| [[VS:Rpstr_GetValueReal]] | |||
| [[VS:Rpstr_SetValueReal]] | |||
| [[VS:Rpstr_GetValueStr]] | |||
| [[VS:Rpstr_SetValueStr]] | |||
</desc> | </desc> | ||
Line 15: | Line 27: | ||
<def> | <def> | ||
<funcDef lang="cpp"> | <funcDef lang="cpp"> | ||
virtual | virtual VCOMError VCOM_CALLTYPE Repository_GetValue(const TXString& name, VWVariant& outValue) = 0; | ||
</funcDef> | </funcDef> | ||
</def> | </def> | ||
Line 25: | Line 37: | ||
name | name | ||
const [[SDK:TXString]]& | const [[SDK:TXString]]& | ||
Name of the value in the repository. | |||
</line> | </line> | ||
<line> | <line> | ||
outValue | outValue | ||
VWVariant& | VWVariant& | ||
The output value. | |||
</line> | </line> | ||
</lineList> | </lineList> | ||
Line 62: | Line 74: | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<seeAlso> | <seeAlso> | ||
[[VCOM:VectorWorks:Scripting:IPythonScriptEngine::Repository RemoveValues]] | | |||
[[VCOM:VectorWorks:Scripting:IPythonScriptEngine::Repository RemoveValue]] | | |||
[[VCOM:VectorWorks:Scripting:IPythonScriptEngine::Repository GetValue]] | | |||
[[VCOM:VectorWorks:Scripting:IPythonScriptEngine::Repository SetValue]] | | |||
[[VCOM:VectorWorks:Scripting:IPythonScriptEngine::Repository GetValueNames]] | |||
</seeAlso> | </seeAlso> | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
Latest revision as of 13:09, 24 September 2013
Description
namespace VectorWorks::Scripting
Member of VCOM:VectorWorks:Scripting:IPythonScriptEngine
One of the functions allowing access to data repository inside the script engine. You can use this repository from within the Script and thus have a way to communicate data in and out the Script.
The following scripting functions are available to access the repository: VS:Rpstr_RemoveValues | VS:Rpstr_RemoveValue | VS:Rpstr_GetValueBool | VS:Rpstr_SetValueBool | VS:Rpstr_GetValueInt | VS:Rpstr_SetValueInt | VS:Rpstr_GetValueReal | VS:Rpstr_SetValueReal | VS:Rpstr_GetValueStr | VS:Rpstr_SetValueStr
virtual VCOMError VCOM_CALLTYPE Repository_GetValue(
const TXString& name,
VWVariant& outValue) = 0;
Parameters
name const SDK:TXString& Name of the value in the repository. outValue VWVariant& The output value.
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
See Also
VCOM:VectorWorks:Scripting:IPythonScriptEngine::Repository RemoveValues |
VCOM:VectorWorks:Scripting:IPythonScriptEngine::Repository RemoveValue | VCOM:VectorWorks:Scripting:IPythonScriptEngine::Repository GetValue | VCOM:VectorWorks:Scripting:IPythonScriptEngine::Repository SetValue | VCOM:VectorWorks:Scripting:IPythonScriptEngine::Repository GetValueNames
[[VCOM:VectorWorks:Scripting:IPythonScriptEngine::Repository RemoveValue]] | [[VCOM:VectorWorks:Scripting:IPythonScriptEngine::Repository GetValue]] | [[VCOM:VectorWorks:Scripting:IPythonScriptEngine::Repository SetValue]] |
[[VCOM:VectorWorks:Scripting:IPythonScriptEngine::Repository GetValueNames]]