VS:ReplaceIFCWithMap: Difference between revisions

From Vectorworks Developer
Jump to navigation Jump to search
No edit summary
No edit summary
Line 45: Line 45:


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


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

Revision as of 09:00, 17 December 2018

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

Description

Deletes attached IFC Record from:

case 1: Object If the HANDLE is not NULL.

case 2: All Objects which corresponds to inStrObjName and HANDLE is NULL.

case 3: All Objects if inStrObjName is "allObjects" and HANDLE is NULL.

FUNCTION ReplaceIFCWithMap(
hObject :HANDLE;
inStrObjName :STRING) : BOOLEAN;
def vs.ReplaceIFCWithMap(hObject, inStrObjName):
    return BOOLEAN

Parameters

hObject HANDLE Object's Handle.
inStrObjName STRING Object name.

Return Value

TRUE on success, FALSE indicates failure.

Example

VectorScript

PROCEDURE Test;
VAR
	ok : BOOLEAN;
BEGIN
	ok := ReplaceIFCWithMap(NULL, 'Wall');
END;

RUN(Test);

Python

ok = vs.ReplaceIFCWithMap(NULL, 'Wall')

Version

Available from: Vectorworks 2017