VS:IFC ClearIFCInfo: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
No edit summary |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 5: | Line 5: | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<desc> | <desc> | ||
Removes all IFC data</desc> | |||
</desc> | |||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<def> | <def> | ||
<funcDef lang="vs"> | <funcDef lang="vs"> | ||
FUNCTION IFC_ClearIFCInfo(hObject: HANDLE) : BOOLEAN; | FUNCTION IFC_ClearIFCInfo(hObject:HANDLE) : BOOLEAN; | ||
</funcDef> | </funcDef> | ||
<funcDef lang="py"> | <funcDef lang="py"> | ||
| Line 25: | Line 24: | ||
hObject | hObject | ||
HANDLE | HANDLE | ||
Handle to object | |||
</line> | </line> | ||
</lineList> | </lineList> | ||
</params> | </params> | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<return> | <return>TRUE on success, FALSE indicates failure –incorrect handle or the object has no IFC data.</return> | ||
TRUE on success, FALSE indicates failure –incorrect handle or the object has no IFC data | |||
</return> | |||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<remark> | <remark></remark> | ||
</remark> | |||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<sample> | <sample> | ||
==== VectorScript ==== | |||
<code lang="pas"> | <code lang="pas"> | ||
IFC_ClearIFCInfo(hObject); | 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> | </code> | ||
</sample> | </sample> | ||
----------------------------------------------------------------------------------------------------------- | |||
<seeAlso></seeAlso> | |||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<version> | <version> | ||
Availability: | Availability: from Vectorworks 2014 | ||
</version> | </version> | ||
</vwDoc> | </vwDoc> | ||
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