Difference between revisions of "VS:IFC GetPsetName"
From Vectorworks Developer
| Line 10: | Line 10: | ||
<def> | <def> | ||
<funcDef lang="vs"> | <funcDef lang="vs"> | ||
| − | + | FUNCTION IFC_GetPsetName(hObject:HANDLE; inPsetIndex:INTEGER; VAR outStrPsetName:STRING) : BOOLEAN; | |
</funcDef> | </funcDef> | ||
<funcDef lang="py"> | <funcDef lang="py"> | ||
| − | def vs.IFC_GetPsetName(hObject, inPsetIndex | + | def vs.IFC_GetPsetName(hObject, inPsetIndex): |
| − | return outStrPsetName | + | return ok, outStrPsetName |
</funcDef> | </funcDef> | ||
</def> | </def> | ||
| Line 35: | Line 35: | ||
STRING | STRING | ||
Name of the pset | Name of the pset | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</line> | </line> | ||
</lineList> | </lineList> | ||
| Line 63: | Line 58: | ||
BEGIN | BEGIN | ||
hObject := FSActLayer; | hObject := FSActLayer; | ||
| − | IFC_GetPsetName(hObject, 1, outStrPsetName | + | ok := IFC_GetPsetName(hObject, 1, outStrPsetName); |
AlrtDialog(outStrPsetName); | AlrtDialog(outStrPsetName); | ||
END; | END; | ||
| Line 72: | Line 67: | ||
<code lang="py"> | <code lang="py"> | ||
hObject = vs.FSActLayer() | hObject = vs.FSActLayer() | ||
| − | ok | + | ok, outStrPsetName = vs. IFC_GetPsetName(hObject, 1) |
| − | outStrPsetName = vs. IFC_GetPsetName(hObject, 1 | + | if ok: |
| − | vs.AlrtDialog(outStrPsetName) | + | vs.AlrtDialog(outStrPsetName) |
| − | + | ||
</code> | </code> | ||
</sample> | </sample> | ||
Revision as of 09:10, 29 October 2014
.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix
Description
Gets the name of the property set at that indexFUNCTION IFC_GetPsetName(
hObject :HANDLE;
inPsetIndex :INTEGER;
VAR outStrPsetName :STRING) : BOOLEAN;
def vs.IFC_GetPsetName(hObject, inPsetIndex):
return ok, outStrPsetName
Parameters
hObject HANDLE Handle to object inPsetIndex INTEGER of the property outStrPsetName STRING Name of the pset
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.
Example
VectorScript
PROCEDURE Test; VAR hObject : HANDLE; outStrPsetName : STRING; ok : BOOLEAN; BEGIN hObject := FSActLayer; ok := IFC_GetPsetName(hObject, 1, outStrPsetName); AlrtDialog(outStrPsetName); END; RUN(Test);
Python
hObject = vs.FSActLayer() ok, outStrPsetName = vs. IFC_GetPsetName(hObject, 1) if ok: vs.AlrtDialog(outStrPsetName)
