VS:ReplaceIFCWithMap: 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
Line 5: Line 5:
-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<desc>
<desc>
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.
</desc>
</desc>


Line 23: Line 27:
<lineList ident=1>
<lineList ident=1>
<line>
<line>
inStrObjName
hObject
STRING
HANDLE
Object's Handle.


</line>
</line>
<line>
<line>
inStrEntryName
inStrObjName
STRING
STRING
 
Object name.
</line>
<line>
inStrFieldName
STRING
 
</line>
<line>
bOptional
BOOLEAN


</line>
</line>
Line 46: Line 42:


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


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<sample></sample>
<sample>
==== VectorScript ====
<code lang="pas">
PROCEDURE Test;
VAR
ok : BOOLEAN;
BEGIN
ok := ReplaceIFCWithMap(NULL, 'Wall');
END;
 
RUN(Test);
</code>
==== Python ====
<code lang="py">
ok = vs.ReplaceIFCWithMap(NULL, 'Wall')
</code>
</sample>


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

Revision as of 15:52, 23 November 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.

Remarks

Return Values

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