VS:GetObjectWallHeight: Difference between revisions
Jump to navigation
Jump to search
m (1 revision: vw2015) |
m (fix typos) |
||
| Line 8: | Line 8: | ||
Gets an object's height value in it's break record. <BR> | Gets an object's height value in it's break record. <BR> | ||
<BR> | <BR> | ||
The | The object (objH) must be contained in wall (wallH) to succeed.</desc> | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
| Line 44: | Line 44: | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<return> | <return> | ||
True or False upon | True or False upon successful setting of the flag. | ||
False can occur for the following conditions: | False can occur for the following conditions: | ||
objH is null. | * objH is null. | ||
wallH is null. | * wallH is null. | ||
objH is not contained in wallH.</return> | * objH is not contained in wallH.</return> | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
Latest revision as of 15:18, 21 September 2014
.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