Difference between revisions of "VS:IFC GetNumPsets"

From Vectorworks Developer
Jump to: navigation, search
 
m
 
(5 intermediate revisions by 3 users not shown)
Line 5: Line 5:
 
-----------------------------------------------------------------------------------------------------------
 
-----------------------------------------------------------------------------------------------------------
 
<desc>
 
<desc>
This function gets the number of Psets, attached to the object.
+
Gets the number of property sets, attached to the object</desc>
</desc>
+
  
 
-----------------------------------------------------------------------------------------------------------
 
-----------------------------------------------------------------------------------------------------------
 
<def>
 
<def>
 
<funcDef lang="vs">
 
<funcDef lang="vs">
FUNCTION IFC_GetNumPsets(hObject: HANDLE; VAR outNumPsets: INTEGER) : BOOLEAN;
+
FUNCTION IFC_GetNumPsets(hObject:HANDLE; VAR outNumPsets:INTEGER) : BOOLEAN;
 
</funcDef>
 
</funcDef>
 
<funcDef lang="py">
 
<funcDef lang="py">
Line 25: Line 24:
 
hObject
 
hObject
 
HANDLE
 
HANDLE
 
+
Handle to object
 
</line>
 
</line>
 
<line>
 
<line>
 
outNumPsets
 
outNumPsets
 
INTEGER
 
INTEGER
 
+
Number of PSets
 
</line>
 
</line>
 
</lineList>
 
</lineList>
 
</params>
 
</params>
 
  
 
-----------------------------------------------------------------------------------------------------------
 
-----------------------------------------------------------------------------------------------------------
<return>
+
<return>TRUE on success, FALSE indicates failure – incorrect handle, the object has no IFC data.</return>
TRUE on success, FALSE indicates failure – incorrect handle, the object has no IFC data;
+
</return>
+
  
 
-----------------------------------------------------------------------------------------------------------
 
-----------------------------------------------------------------------------------------------------------
<remark>
+
<remark></remark>
None.
+
</remark>
+
  
 
-----------------------------------------------------------------------------------------------------------
 
-----------------------------------------------------------------------------------------------------------
 
<sample>
 
<sample>
 +
==== VectorScript ====
 
<code lang="pas">
 
<code lang="pas">
IFC_GetNumPsets(hObject, iNum);
+
PROCEDURE Test;
 +
VAR
 +
hObject : HANDLE;
 +
iNum : INTEGER;
 +
ok : BOOLEAN;
 +
begin
 +
hObject := FSActLayer;
 +
ok := IFC_GetNumPsets(hObject, iNum);
 +
AlrtDialog(Concat(iNum));
 +
end;
 +
 
 +
Run(Test);
 +
</code>
 +
==== Python ====
 +
<code lang="py">
 +
ok, iNum = vs.IFC_GetNumPsets(vs.FSActLayer())
 +
vs.AlrtDialog(str(iNum))
 
</code>
 
</code>
 
 
</sample>
 
</sample>
 +
 +
-----------------------------------------------------------------------------------------------------------
 +
<seeAlso></seeAlso>
  
 
-----------------------------------------------------------------------------------------------------------
 
-----------------------------------------------------------------------------------------------------------
 
<version>
 
<version>
Availability: 2010
+
Availability: from Vectorworks 2014
  
 
</version>
 
</version>
 
-----------------------------------------------------------------------------------------------------------
 
<seeAlso>
 
</seeAlso>
 
  
 
</vwDoc>
 
</vwDoc>

Latest revision as of 04:10, 28 January 2019

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

Description

Gets the number of property sets, attached to the object
FUNCTION IFC_GetNumPsets(
hObject  :HANDLE;
VAR outNumPsets  :INTEGER) : BOOLEAN;
def vs.IFC_GetNumPsets(hObject):
    return (BOOLEAN, outNumPsets)

Parameters

hObject HANDLE Handle to object
outNumPsets INTEGER Number of PSets

Return Value

TRUE on success, FALSE indicates failure – incorrect handle, the object has no IFC data.

Example

VectorScript

PROCEDURE Test;
VAR
	hObject : HANDLE;
	iNum : INTEGER;
	ok : BOOLEAN;
BEGIN
	hObject := FSActLayer;
	ok := IFC_GetNumPsets(hObject, iNum);
	AlrtDialog(Concat(iNum));
END;

RUN(Test);

Python

ok, iNum = vs.IFC_GetNumPsets(vs.FSActLayer())
vs.AlrtDialog(str(iNum))

Version

Availability: from Vectorworks 2014
Personal tools
NamespacesFFFF

Variants
Actions
Advanced Search
See Also
Navigation
Toolbox