VS:GetComponentName

From Vectorworks Developer
Revision as of 19:49, 10 February 2016 by CBM-c- (talk | contribs) (Shorten OBJECT, reserved word)
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

.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.

Return Value

The name of the component.

Version

Availability: from VectorWorks 2008

See Also

VS Functions:

VS:SetComponentName

VS Functions: [[VS:SetComponentName]]
Retrieved from "http://developer.vectorworks.net/index.php?title=VS:GetComponentName&oldid=21501"