VS:IFC GetPsetInfoAt

From Vectorworks Developer
Revision as of 03:18, 18 December 2018 by Sasha (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

.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.

Example

VectorScript

PROCEDURE Test;
VAR
	hObject : HANDLE;
	ok 	: BOOLEAN;
	outName	: STRING;
	outType	: INTEGER;
	
BEGIN
	ok := IFC_GetPsetInfoAt(hObject, TRUE, 0, outName, outType);
END;

RUN(Test);

Python

hObject	= vs.Handle()
ok	= false
outName	= ""
outType	= -1

ok	= vs.IFC_GetPsetInfoAt(hObject, true, 0, outName, outType)

Version

Availability: from Vectorworks 2018
Personal tools
NamespacesFFFF

Variants
Actions
Advanced Search
See Also
Navigation
Toolbox