VS:IFC ClearAllPsets: Difference between revisions

From Vectorworks Developer
Jump to navigation Jump to search
(Created page with "{{LocationMain|category=LocationVS|specific=}} __TOC__ <vwDoc> ----------------------------------------------------------------------------------------------------------- <de...")
 
No edit summary
 
(One intermediate revision by one other user not shown)
Line 25: Line 25:
hObject
hObject
HANDLE
HANDLE
...
Handle to object.
</line>
</line>
</lineList>
</lineList>
Line 31: Line 31:


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<remark>
<return>
===== Return Values =====
TRUE on success, FALSE indicates failure.
TRUE on success, FALSE indicates failure.
</remark>
</return>
 
-----------------------------------------------------------------------------------------------------------
<remark></remark>


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<sample>
<sample>
==== VectorScript ====
==== VectorScript ====
<code lang="pas">
<code lang="pas">
PROCEDURE Test;
VAR
hObject : HANDLE;
ok : BOOLEAN;
BEGIN
hObject := FSActLayer;
ok := IFC_ClearAllPsets(hObject);
END;
RUN(Test);
</code>
</code>
==== Python ====
==== Python ====
<code lang="py">
<code lang="py">
hObject = vs.FSActLayer()
ok = vs.IFC_ClearAllPsets(hObject)
</code>
</code>
</sample>
</sample>

Latest revision as of 08:46, 17 December 2018

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

Description

Removes all IFC Psets.

FUNCTION IFC_ClearAllPsets(
hObject :HANDLE) : BOOLEAN;
def vs.IFC_ClearAllPsets(hObject):
    return BOOLEAN

Parameters

hObject HANDLE Handle to object.

Return Value

TRUE on success, FALSE indicates failure.

Example

VectorScript

PROCEDURE Test;
VAR
	hObject : HANDLE;
	ok : BOOLEAN;
BEGIN
	hObject := FSActLayer;
	ok := IFC_ClearAllPsets(hObject);
END;

RUN(Test);

Python

hObject = vs.FSActLayer()
ok = vs.IFC_ClearAllPsets(hObject)

Version

Availability: from Vectorworks 2011