Difference between revisions of "VS:GetObjWallInsertMode"

From Vectorworks Developer
Jump to: navigation, 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.<BR>
+
Returns the insertion mode for an object in a wall.
<BR>
+
 
1 - Center<BR>
+
# Center
2 - Leaf Edge<BR>
+
# Leaf Edge
3 - Right Edge<BR>
+
# Right Edge
<BR>
+
 
<BR>
+
 
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 02: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.
  1. Center
  2. Leaf Edge
  3. 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
Personal tools
NamespacesFFFF

Variants
Actions
Advanced Search
See Also
Navigation
Toolbox