Difference between revisions of "VS:IFC GetPsetName"
From Vectorworks Developer
m (1 revision) |
|||
| Line 24: | Line 24: | ||
hObject | hObject | ||
HANDLE | HANDLE | ||
| − | + | Handle to object | |
</line> | </line> | ||
<line> | <line> | ||
inPsetIndex | inPsetIndex | ||
INTEGER | INTEGER | ||
| − | + | of the property | |
</line> | </line> | ||
<line> | <line> | ||
outStrPsetName | outStrPsetName | ||
STRING | STRING | ||
| − | + | Name of the pset | |
</line> | </line> | ||
<line> | <line> | ||
| Line 45: | Line 45: | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
| − | <remark></remark> | + | <remark> |
| + | ===== Return Values ===== | ||
| + | TRUE on success, FALSE indicates failure – incorrect handle, the object has no IFC data, index out of range. | ||
| + | |||
| + | 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></sample> | + | <sample> |
| + | ==== VectorScript ==== | ||
| + | <code lang="pas"> | ||
| + | |||
| + | </code> | ||
| + | ==== Python ==== | ||
| + | <code lang="py"> | ||
| + | |||
| + | </code> | ||
| + | </sample> | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
Revision as of 04:57, 27 October 2014
.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix
Description
Gets the name of the property set at that indexPROCEDURE IFC_GetPsetName(
hObject :HANDLE;
inPsetIndex :INTEGER;
VAR outStrPsetName :STRING;
RETURN :BOOLEAN);
def vs.IFC_GetPsetName(hObject, inPsetIndex, RETURN):
return outStrPsetName
Parameters
hObject HANDLE Handle to object inPsetIndex INTEGER of the property outStrPsetName STRING Name of the pset RETURN BOOLEAN
Remarks
Return Values
TRUE on success, FALSE indicates failure – incorrect handle, the object has no IFC data, index out of range.
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.
