VS:GetNumHoles: Difference between revisions

Latest revision as of 16:47, 2 February 2023

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

Returns the number of openings in the referenced polyline.

FUNCTION GetNumHoles(
           inPolyline        :HANDLE;
           VAR outNumHoles   :INTEGER) : BOOLEAN;

def vs.GetNumHoles(inPolyline):
    return (BOOLEAN, outNumHoles)

inPolyline		HANDLE		Handle to polyline.
outNumHoles		INTEGER		The number of openings in the polyline object.

This function never returns FALSE regardless of the object type of "inPolyline" or whether "inPolyline" has holes.

It will only return FALSE on "inPolyine" = NIL.

Availability: from VectorWorks9.0

@@ Line 33: / Line 33: @@
 </lineList>
 </params>
------------------------------------------------------------------------------------------------------------
-<return>
-Returns TRUE if the polyline contains openings, otherwise returns FALSE.</return>
 -----------------------------------------------------------------------------------------------------------
 <remark>
+This function never returns FALSE regardless of the object type of "inPolyline" or whether "inPolyline" has holes.
+It will only return FALSE on "inPolyine" = NIL.
+</remark>
-This routine never fails returning false, unregarded the object type of the handle "inPolyline" that you pass to it, or whether the polyline has holes or not.
-It will only fail on "inPolyine" = NIL.</remark>
 -----------------------------------------------------------------------------------------------------------