VS:IFC ClearPset: Difference between revisions
Jump to navigation
Jump to search
(Created page with " {{LocationMain|category=LocationVS|specific=}} __TOC__ <vwDoc> ----------------------------------------------------------------------------------------------------------- <d...") |
No edit summary |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 6: | Line 6: | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<desc> | <desc> | ||
Removes a | Removes a Property Set from the object's attached Ifc Record. | ||
</desc> | </desc> | ||
| Line 31: | Line 31: | ||
inStrPsetName | inStrPsetName | ||
STRING | STRING | ||
The name of the | The name of the Property Set. | ||
</line> | </line> | ||
</lineList> | </lineList> | ||
</params> | </params> | ||
----------------------------------------------------------------------------------------------------------- | |||
<return>TRUE on success, FALSE indicates failure.</return> | |||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
| Line 40: | Line 43: | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<sample></sample> | <sample> | ||
Assume we want to clear a "PSet_WallCommon" from Object which has already attached Ifc Record with that Property Set: | |||
==== VectorScript ==== | |||
<code lang="pas"> | |||
PROCEDURE Test; | |||
VAR | |||
hObject : HANDLE; | |||
ok : BOOLEAN; | |||
BEGIN | |||
hObject := FSActLayer; | |||
ok := IFC_ClearPset(hObject, 'PSet_WallCommon'); | |||
END; | |||
RUN(Test); | |||
</code> | |||
==== Python ==== | |||
<code lang="py"> | |||
hObject = vs.FSActLayer() | |||
ok = vs.IFC_ClearPset(hObject, 'PSet_WallCommon') | |||
</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 a Property Set from the object's attached Ifc Record.
FUNCTION IFC_ClearPset(
hObject :HANDLE;
inStrPsetName :STRING) : BOOLEAN;
def vs.IFC_ClearPset(hObject, inStrPsetName):
return BOOLEAN
Parameters
hObject HANDLE Handle to the object. inStrPsetName STRING The name of the Property Set.
Return Value
TRUE on success, FALSE indicates failure.
Example
Assume we want to clear a "PSet_WallCommon" from Object which has already attached Ifc Record with that Property Set:
VectorScript
PROCEDURE Test; VAR hObject : HANDLE; ok : BOOLEAN; BEGIN hObject := FSActLayer; ok := IFC_ClearPset(hObject, 'PSet_WallCommon'); END; RUN(Test);
Python
hObject = vs.FSActLayer() ok = vs.IFC_ClearPset(hObject, 'PSet_WallCommon')
Version
Available from: Vectorworks 2016