VS:GetComponentName: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
No edit summary |
||
(2 intermediate revisions by 2 users not shown) | |||
Line 11: | Line 11: | ||
<def> | <def> | ||
<funcDef lang="vs"> | <funcDef lang="vs"> | ||
FUNCTION GetComponentName( | FUNCTION GetComponentName(obj:HANDLE; componentIndex:INTEGER) : STRING; | ||
</funcDef> | </funcDef> | ||
<funcDef lang="py"> | <funcDef lang="py"> | ||
def vs.GetComponentName( | def vs.GetComponentName(obj, componentIndex): | ||
return STRING | return STRING | ||
</funcDef> | </funcDef> | ||
Line 23: | Line 23: | ||
<lineList ident=1> | <lineList ident=1> | ||
<line> | <line> | ||
obj | |||
HANDLE | HANDLE | ||
The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. | The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. | ||
Line 30: | Line 30: | ||
componentIndex | componentIndex | ||
INTEGER | INTEGER | ||
The index of the component. | The index of the component, 1-based. | ||
</line> | </line> | ||
</lineList> | </lineList> |
Latest revision as of 12:03, 20 March 2020
.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix
Description
Gets the name of a component in an object.
FUNCTION GetComponentName(
obj :HANDLE;
componentIndex :INTEGER) : STRING;
def vs.GetComponentName(obj, componentIndex): return STRING
Parameters
obj HANDLE The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences. componentIndex INTEGER The index of the component, 1-based.
Return Value
Version
Availability: from VectorWorks 2008
See Also
VS Functions:
VS Functions:
[[VS:SetComponentName]]