VS:IFC ClearIFCInfo: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
No edit summary |
||
| Line 24: | Line 24: | ||
hObject | hObject | ||
HANDLE | HANDLE | ||
Handle to object | |||
</line> | </line> | ||
</lineList> | </lineList> | ||
| Line 30: | Line 30: | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<remark></remark> | <remark> | ||
===== Return Values ===== | |||
TRUE on success, FALSE indicates failure –incorrect handle or the object has no IFC data. | |||
</remark> | |||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<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> | |||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
Revision as of 13:47, 27 October 2014
.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
Remarks
Return Values
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