VS:GetObjectWallHeight

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

Description

Gets an object's height value in it's break record.

The object (objH) must be contained in wall (wallH) to succeed.

FUNCTION GetObjectWallHeight(
               objH         :HANDLE;
               wallH        :HANDLE;
               VAR height   :REAL) : BOOLEAN;

def vs.GetObjectWallHeight(objH, wallH):
    return (BOOLEAN, height)

Parameters

objH		HANDLE
wallH		HANDLE
height		REAL

Return Value

True or False upon successful setting of the flag.

False can occur for the following conditions:

• objH is null.
• wallH is null.
• objH is not contained in wallH.

Version

Availability: from Vectorworks 2015