VS:GetObjectVariableString

From Vectorworks Developer
Jump to: navigation, search

.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix

Description

Returns the value of a VectorWorks object property. Used with properties returning a STRING value.

For specific object selector index values, see the Appendix.

FUNCTION GetObjectVariableString(
h  :HANDLE;
index  :INTEGER) : STRING;
def vs.GetObjectVariableString(h, index):
    return STRING

Parameters

h HANDLE Handle to object.
index INTEGER Object property index.

Return Value

Returns the value of the property as a STRING value.

Example

VectorScript

dimstdName:= GetObjectVariableString(h,27);

Python

dimstdName = vs.GetObjectVariableString(h,27)

Version

Availability: from VectorWorks9.0
Personal tools
NamespacesFFFF

Variants
Actions
Advanced Search
See Also
Navigation
Toolbox