VS:IFC GetIFCScheme: Difference between revisions

From Vectorworks Developer
Jump to navigation Jump to search
m (1 revision)
No edit summary
 
(2 intermediate revisions by one other user not shown)
Line 6: Line 6:
-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<desc>
<desc>
Gets the active IFC version</desc>
Gets the active IFC version.</desc>


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
Line 13: Line 13:
FUNCTION IFC_GetIFCScheme(VAR outScheme:INTEGER) : BOOLEAN;
FUNCTION IFC_GetIFCScheme(VAR outScheme:INTEGER) : BOOLEAN;
</funcDef>
</funcDef>
<funcDef lang="py">
<funcDef lang="py">
def vs.IFC_GetIFCScheme():
def vs.IFC_GetIFCScheme():
Line 25: Line 26:
outScheme
outScheme
INTEGER
INTEGER
 
Possible out values are <b>kIFCSupportScheme_2x2 = 2 (IFC 2x2); <b>kIFCSupportScheme_2x3 = 3 (IFC 2x3) and <b>kIFCSupportScheme_2x4 = 4 (IFC 4)
</line>
</line>
</lineList>
</lineList>
</params>
</params>
-----------------------------------------------------------------------------------------------------------
<return>TRUE on success, FALSE on failure.</return>


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
Line 34: Line 38:


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<sample></sample>
<sample>
==== VectorScript ====
<code lang="pas">
PROCEDURE Test;
VAR
scheme : INTEGER;
ok : BOOLEAN;
BEGIN
ok := IFC_GetIFCScheme(scheme);
END;
 
RUN(Test);
</code>
 
<code lang="py">
scheme = -1
ok = vs.IFC_GetIFCScheme(scheme)
 
</code>
</sample>


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<seeAlso></seeAlso>
<seeAlso>
[[VCOM:VectorWorks:IFCLib:IFCEnumerations|IFC Enumeration Types]]
</seeAlso>


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------

Latest revision as of 13:23, 16 February 2021

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

Description

Gets the active IFC version.

FUNCTION IFC_GetIFCScheme(
VAR outScheme :INTEGER) : BOOLEAN;
def vs.IFC_GetIFCScheme():
    return (BOOLEAN, outScheme)

Parameters

outScheme INTEGER Possible out values are kIFCSupportScheme_2x2 = 2 (IFC 2x2); kIFCSupportScheme_2x3 = 3 (IFC 2x3) and kIFCSupportScheme_2x4 = 4 (IFC 4)

Return Value

TRUE on success, FALSE on failure.

Example

VectorScript

PROCEDURE Test;
VAR
	scheme	: INTEGER;
	ok 	: BOOLEAN;
BEGIN
	ok := IFC_GetIFCScheme(scheme);
END;

RUN(Test);
scheme	= -1
ok	= vs.IFC_GetIFCScheme(scheme)

Version

Availability: from Vectorworks 2017

See Also

IFC Enumeration Types

[[VCOM:VectorWorks:IFCLib:IFCEnumerations|IFC Enumeration Types]]