View source for VS:IFC DefPsetBegin


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

-----------------------------------------------------------------------------------------------------------
<desc>
Marks the beginning of creation of a new Custom Object Property set (PSet).</desc>

-----------------------------------------------------------------------------------------------------------
<def>
<funcDef lang="vs">
FUNCTION IFC_DefPsetBegin(psetName:STRING) : BOOLEAN;
</funcDef>
<funcDef lang="py">
def vs.IFC_DefPsetBegin(psetName):
    return BOOLEAN
</funcDef>
</def>

-----------------------------------------------------------------------------------------------------------
<params>
<lineList ident=1>
<line>
psetName
STRING
The name of the Custom PSet.
</line>
</lineList>
</params>

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

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

-----------------------------------------------------------------------------------------------------------
<sample>
==== VectorScript ====
<code lang="pas">
PROCEDURE Test;
VAR
	ok	: BOOLEAN;
	psetName: STRING;
	
BEGIN
	psetName:= 'My Custom Pset';

	ok	:= IFC_DefPsetBegin( psetName );
	ok	:= IFC_DefPsetAddMember( psetName, 'Field', 'IfcInteger' );
	ok	:= IFC_DefPsetEnd( psetName );
END;

RUN(Test);
</code>
==== Python ====
<code lang="py">
psetName	= "My Custom Pset"

ok	= vs.IFC_DefPsetBegin( psetName )
ok	= vs.IFC_DefPsetAddMember( psetName, "Field", "IfcInteger" )
ok	= vs.IFC_DefPsetEnd( psetName )

</code>
</sample>
-----------------------------------------------------------------------------------------------------------
<seeAlso>
[[VS:IFC_DefPsetEnd|IFC_DefPsetEnd]]
[[VS:IFC_DefPsetImport|IFC_DefPsetImport]]

[[VS:IFC_DefPsetAddMember|IFC_DefPsetAddMember]]
</seeAlso>

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

</version>

</vwDoc>

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