View source for VS:IFC GetEntityProp

{{LocationMain|category=LocationVS|specific=}}
__TOC__
<vwDoc>

-----------------------------------------------------------------------------------------------------------
<desc>
Gets the value and type of a selected property from the IFC entity.</desc>

-----------------------------------------------------------------------------------------------------------
<def>
<funcDef lang="vs">
FUNCTION IFC_GetEntityProp(hObject:HANDLE; inStrPropName:STRING; VAR outStrPropValue:STRING; VAR outTypeSelect:INTEGER) : BOOLEAN;
</funcDef>
<funcDef lang="py">
def vs.IFC_GetEntityProp(hObject, inStrPropName):
    return (BOOLEAN, outStrPropValue, outTypeSelect)
</funcDef>
</def>

-----------------------------------------------------------------------------------------------------------
<params>
<lineList ident=1>
<line>
hObject
HANDLE
Handle to object
</line>
<line>
inStrPropName
STRING
Name of the property
</line>
<line>
outStrPropValue
STRING
Value of the property
</line>
<line>
outTypeSelect
INTEGER
Type of the property
</line>
</lineList>
</params>

-----------------------------------------------------------------------------------------------------------
<return>TRUE on success, FALSE indicates failure – incorrect handle, the object has no IFC data, incorrect name of the property.

outTypeSelect – value depends on the property type: 1 – identifier, 2 – double, 3 – boolean, 4 – integer, 5 – number (same as double), 6 – logical, 7 – string, 8 – enu-meration, 9 – select value</return>

-----------------------------------------------------------------------------------------------------------
<remark></remark>

-----------------------------------------------------------------------------------------------------------
<sample>
==== VectorScript ====
<code lang="pas">
PROCEDURE Test;
VAR
	strPropValue: STRING;
	hExtrude : HANDLE;
	iType : INTEGER;
	ok : BOOLEAN;
BEGIN
	hExtrude:= FSActLayer;
	ok := IFC_GetEntityProp(hExtrude, 'PredefinedType', strPropValue, iType);
	AlrtDialog(Concat(strPropValue, ' ,  ',  iType));
END;

RUN(Test);
</code>
==== Python ====
<code lang="py">
hExtrude = vs.FSActLayer()
ok, strPropValue, iType = vs.IFC_GetEntityProp(hExtrude, 'PredefinedType')
vs.AlrtDialog(strPropValue + ' ,  ' + str(iType));
</code>
</sample>

-----------------------------------------------------------------------------------------------------------
<seeAlso></seeAlso>

-----------------------------------------------------------------------------------------------------------
<version>
Availability: from Vectorworks 2014

</version>

</vwDoc>

[[Category:VS Function Reference|IFC_GetEntityProp]]
[[Category:VS Function Reference:IFC|IFC_GetEntityProp]]