VS:IFC ClearIFCInfo: Difference between revisions

From Vectorworks Developer
Jump to navigation Jump to search
m (1 revision)
No edit summary
 
(One intermediate revision by the same user not shown)
Line 24: Line 24:
hObject
hObject
HANDLE
HANDLE
 
Handle to object
</line>
</line>
</lineList>
</lineList>
</params>
</params>
-----------------------------------------------------------------------------------------------------------
<return>TRUE on success, FALSE indicates failure –incorrect handle or the object has no IFC data.</return>


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
Line 33: Line 36:


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


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------

Latest revision as of 08:47, 17 December 2018

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

Description

Removes all IFC data

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

Parameters

hObject HANDLE Handle to object

Return Value

TRUE on success, FALSE indicates failure –incorrect handle or the object has no IFC data.

Example

VectorScript

PROCEDURE Test;
VAR
	hObject : HANDLE;
	ok : BOOLEAN;
begin
	hObject := FSActLayer;
	ok := IFC_ClearIFCInfo(hObject);
end;

RUN(Test);

Python

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

Version

Availability: from Vectorworks 2014