Difference between revisions of "VS:IFC GetPsetName"

From Vectorworks Developer
Jump to: navigation, search
m (1 revision)
Line 5: Line 5:
 
-----------------------------------------------------------------------------------------------------------
 
-----------------------------------------------------------------------------------------------------------
 
<desc>
 
<desc>
This function gets the name of the Pset at specified index.
+
Gets the name of the property set at that index</desc>
</desc>
+
  
 
-----------------------------------------------------------------------------------------------------------
 
-----------------------------------------------------------------------------------------------------------
 
<def>
 
<def>
 
<funcDef lang="vs">
 
<funcDef lang="vs">
FUNCTION IFC_GetPsetName(hObject: HANDLE; inPsetIndex: INTEGER; VAR outStrPsetName: STRING) : BOOLEAN;
+
PROCEDURE IFC_GetPsetName(hObject:HANDLE; inPsetIndex:INTEGER; VAR outStrPsetName:STRING; RETURN:BOOLEAN);
 
</funcDef>
 
</funcDef>
 
<funcDef lang="py">
 
<funcDef lang="py">
Line 35: Line 34:
 
outStrPsetName
 
outStrPsetName
 
STRING
 
STRING
 +
 +
</line>
 +
<line>
 +
RETURN
 +
BOOLEAN
  
 
</line>
 
</line>
 
</lineList>
 
</lineList>
 
</params>
 
</params>
 
  
 
-----------------------------------------------------------------------------------------------------------
 
-----------------------------------------------------------------------------------------------------------
<return>
+
<remark></remark>
TRUE on success, FALSE indicates failure – incorrect handle, the object has no IFC data, index out of range;
+
</return>
+
  
 
-----------------------------------------------------------------------------------------------------------
 
-----------------------------------------------------------------------------------------------------------
<remark>
+
<sample></sample>
Use this function in conjunction with IFC_GetNumPsets. If inPsetIndex = 1, the function will return the name of the first pset, attached to the object.
+
</remark>
+
  
 
-----------------------------------------------------------------------------------------------------------
 
-----------------------------------------------------------------------------------------------------------
<sample>
+
<seeAlso></seeAlso>
<code lang="pas">
+
IFC_GetPsetName(hObject, 1, outStrPsetName);
+
</code>
+
 
+
</sample>
+
  
 
-----------------------------------------------------------------------------------------------------------
 
-----------------------------------------------------------------------------------------------------------
 
<version>
 
<version>
Availability: 2010
+
Availability: from Vectorworks 2014
  
 
</version>
 
</version>
 
-----------------------------------------------------------------------------------------------------------
 
<seeAlso>
 
</seeAlso>
 
  
 
</vwDoc>
 
</vwDoc>

Revision as of 13:36, 18 September 2013

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

Description

Gets the name of the property set at that index
PROCEDURE IFC_GetPsetName(
hObject  :HANDLE;
inPsetIndex  :INTEGER;
VAR outStrPsetName  :STRING;
RETURN  :BOOLEAN);
def vs.IFC_GetPsetName(hObject, inPsetIndex, RETURN):
    return outStrPsetName

Parameters

hObject HANDLE
inPsetIndex INTEGER
outStrPsetName STRING
RETURN BOOLEAN

Version

Availability: from Vectorworks 2014
Personal tools
NamespacesFFFF

Variants
Actions
Advanced Search
See Also
Navigation
Toolbox