VS:GetObjWallInsertMode: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
(wikify to remove extra spaces) |
||
Line 6: | Line 6: | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<desc> | <desc> | ||
Returns the insertion mode for an object in a wall. | Returns the insertion mode for an object in a wall. | ||
# Center | |||
# Leaf Edge | |||
# Right Edge | |||
The object (objH) must be contained in wall (wallH) to succeed.</desc> | The object (objH) must be contained in wall (wallH) to succeed.</desc> | ||
Revision as of 06:45, 14 January 2017
.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix
Description
Returns the insertion mode for an object in a wall.
- Center
- Leaf Edge
- Right Edge
The object (objH) must be contained in wall (wallH) to succeed.
FUNCTION GetObjWallInsertMode(
objH :HANDLE;
wallH :HANDLE;
VAR insertMode :INTEGER) : Boolean;
def vs.GetObjWallInsertMode(objH, wallH, insertMode): return (Boolean, insertMode)
Parameters
objH HANDLE wallH HANDLE insertMode INTEGER
Return Value
True or False upon successful retrieving of the insertion mode.
False can occur for the following conditions:
objH is null.
wallH is null.
objH is not contained in wallH.
Version
Availability: from Vectorworks 2017