Difference between revisions of "VS:IFC GetPsetInfoAt"

From Vectorworks Developer
Jump to: navigation, search
m (1 revision)
Line 6: Line 6:
 
-----------------------------------------------------------------------------------------------------------
 
-----------------------------------------------------------------------------------------------------------
 
<desc>
 
<desc>
Gets the Pset name and if it is attached and where from (if it is from mapping or from record).</desc>
+
Returns the property set name, if it is attached and where from (mapping or record). </desc>
  
 
-----------------------------------------------------------------------------------------------------------
 
-----------------------------------------------------------------------------------------------------------
Line 25: Line 25:
 
hObject
 
hObject
 
HANDLE
 
HANDLE
 
+
Handle to object.
 
</line>
 
</line>
 
<line>
 
<line>
 
bAllPsets
 
bAllPsets
 
BOOLEAN
 
BOOLEAN
 
+
Boolean that defines whether customPsets are to be checked.
 
</line>
 
</line>
 
<line>
 
<line>
 
index
 
index
 
INTEGER
 
INTEGER
 
+
Index that defines the pset position.
 
</line>
 
</line>
 
<line>
 
<line>
 
outIfcPsetName
 
outIfcPsetName
 
STRING
 
STRING
 
+
Out parameter for the property set name.
 
</line>
 
</line>
 
<line>
 
<line>
 
outType
 
outType
 
INTEGER
 
INTEGER
 
+
Returns the index that defines the state of the Pset. Possible values are: -2 (pset forbidden from mapping, NOT attached in record), -1 (pset forbidden from mapping, but attached in record), 0 (pset NOT attached), 1 (pset attached from record), 2 (pset attached from mapping).
 
</line>
 
</line>
 
</lineList>
 
</lineList>
 
</params>
 
</params>
 +
 +
-----------------------------------------------------------------------------------------------------------
 +
<return>
 +
TRUE on success, FALSE indicates failure.
 +
</return>
  
 
-----------------------------------------------------------------------------------------------------------
 
-----------------------------------------------------------------------------------------------------------

Revision as of 04:43, 17 December 2018

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

Description

Returns the property set name, if it is attached and where from (mapping or record).
FUNCTION IFC_GetPsetInfoAt(
hObject  :HANDLE;
bAllPsets  :BOOLEAN;
index  :INTEGER;
VAR outIfcPsetName  :STRING;
VAR outType  :INTEGER) : BOOLEAN;
def vs.IFC_GetPsetInfoAt(hObject, bAllPsets, index):
    return (BOOLEAN, outIfcPsetName, outType)

Parameters

hObject HANDLE Handle to object.
bAllPsets BOOLEAN Boolean that defines whether customPsets are to be checked.
index INTEGER Index that defines the pset position.
outIfcPsetName STRING Out parameter for the property set name.
outType INTEGER Returns the index that defines the state of the Pset. Possible values are: -2 (pset forbidden from mapping, NOT attached in record), -1 (pset forbidden from mapping, but attached in record), 0 (pset NOT attached), 1 (pset attached from record), 2 (pset attached from mapping).

Return Value

TRUE on success, FALSE indicates failure.

Version

Availability: from Vectorworks 2018
Personal tools
NamespacesFFFF

Variants
Actions
Advanced Search
See Also
Navigation
Toolbox