View source for VS:IFC GetPsetInfoAt


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

-----------------------------------------------------------------------------------------------------------
<desc>
Returns the property set name, if it is attached and where from (mapping or record). </desc>

-----------------------------------------------------------------------------------------------------------
<def>
<funcDef lang="vs">
FUNCTION IFC_GetPsetInfoAt(hObject:HANDLE; bAllPsets:BOOLEAN; index:INTEGER; VAR outIfcPsetName:STRING; VAR outType:INTEGER) : BOOLEAN;
</funcDef>
<funcDef lang="py">
def vs.IFC_GetPsetInfoAt(hObject, bAllPsets, index):
    return (BOOLEAN, outIfcPsetName, outType)
</funcDef>
</def>

-----------------------------------------------------------------------------------------------------------
<params>
<lineList ident=1>
<line>
hObject
HANDLE
Handle to object.
</line>
<line>
bAllPsets
BOOLEAN
Boolean that defines whether customPsets are to be checked.
</line>
<line>
index
INTEGER
Index that defines the pset position.
</line>
<line>
outIfcPsetName
STRING
Out parameter for the property set name.
</line>
<line>
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).
</line>
</lineList>
</params>

-----------------------------------------------------------------------------------------------------------
<return>
TRUE on success, FALSE indicates failure. 
</return>

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

-----------------------------------------------------------------------------------------------------------
<sample>
==== VectorScript ====
<code lang="pas">
</code>

==== Python ====
<code lang="py">
</code>
</sample>

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

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

</version>

</vwDoc>

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