Difference between revisions of "VS:IFC GetPsetProp"

From Vectorworks Developer
Jump to: navigation, search
 
(One intermediate revision by one user not shown)
Line 50: Line 50:
  
 
-----------------------------------------------------------------------------------------------------------
 
-----------------------------------------------------------------------------------------------------------
<remark>
+
<return>
===== Return Values =====
+
 
TRUE on success, FALSE indicates failure – incorrect handle, the object has no IFC data, incorrect name of the pset or property.
 
TRUE on success, FALSE indicates failure – incorrect handle, the object has no IFC data, incorrect name of the pset or 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.
 
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.
</remark>
+
</return>
 +
 
 +
-----------------------------------------------------------------------------------------------------------
 +
<remark></remark>
  
 
-----------------------------------------------------------------------------------------------------------
 
-----------------------------------------------------------------------------------------------------------
Line 69: Line 71:
 
begin
 
begin
 
hWall := FSActLayer;
 
hWall := FSActLayer;
ok := IFC_SetPsetProp(hWall, 'Pset_WallCommon', 'Reference', outValue, iType);
+
ok := IFC_GetPsetProp(hWall, 'Pset_WallCommon', 'Reference', outValue, iType);
 +
AlrtDialog(Concat(outValue, ', ', iType));
 
END;
 
END;
  
Line 77: Line 80:
 
<code lang="py">
 
<code lang="py">
 
hWall = vs.FSActLayer()
 
hWall = vs.FSActLayer()
ok, outValue, iType  = vs.IFC_SetPsetProp(hWall, 'Pset_WallCommon', 'Reference')
+
ok, outValue, iType  = vs.IFC_GetPsetProp(hWall, 'Pset_WallCommon', 'Reference')
 +
vs.AlrtDialog(outValue + ', ' + str(iType))
 
</code>
 
</code>
 
</sample>
 
</sample>

Latest revision as of 04:59, 17 December 2018

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

Description

Gets the value and type of a selected property from a property set
FUNCTION IFC_GetPsetProp(
hObject  :HANDLE;
inStrPsetName  :STRING;
inStrPropName  :STRING;
VAR outStrPropValue  :STRING;
VAR outTypeSelect  :INTEGER) : BOOLEAN;
def vs.IFC_GetPsetProp(hObject, inStrPsetName, inStrPropName):
    return (BOOLEAN, outStrPropValue, outTypeSelect)

Parameters

hObject HANDLE Handle to object
inStrPsetName STRING Name of the pset
inStrPropName STRING Name of the property
outStrPropValue STRING Value of the property
outTypeSelect INTEGER Type of the property

Return Value

TRUE on success, FALSE indicates failure – incorrect handle, the object has no IFC data, incorrect name of the pset or 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.

Example

VectorScript

PROCEDURE Test;
VAR
	hWall : HANDLE;
	outValue : STRING;
	iType : INTEGER;
	ok : BOOLEAN;
BEGIN
	hWall := FSActLayer;
	ok := IFC_GetPsetProp(hWall, 'Pset_WallCommon', 'Reference', outValue, iType);
	AlrtDialog(Concat(outValue, ', ', iType));
END;

RUN(Test);

Python

hWall = vs.FSActLayer()
ok, outValue, iType  = vs.IFC_GetPsetProp(hWall, 'Pset_WallCommon', 'Reference')
vs.AlrtDialog(outValue + ', ' + str(iType))

Version

Availability: from Vectorworks 2014
Personal tools
NamespacesFFFF

Variants
Actions
Advanced Search
See Also
Navigation
Toolbox