Difference between revisions of "API Component.GetCompile"

From Flowcode Help
Jump to navigationJump to search
(XML import)
Line 1: Line 1:
<sidebar>API Contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Gets whether a component will be compiled or not
+
|-
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
<div style="width:25%; float:right" class="toc">
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetCompile'''
====Class hierarchy====
+
|-
[[API Component|Component]]
+
| colspan="2" | Gets whether a component will be compiled or not&nbsp;
:[[API Component|GetCompile]]
+
|-
</div>
+
|-
__TOC__
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 
+
| width="90%" | Target
==Parameters==
+
|-
[[Variable Types|HANDLE]] ''Target''
+
| colspan="2" | The component to read the state from&nbsp;
:The component to read the state from
+
|-
:''The default value for this parameter is: '''''this'''
+
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 
+
| width="90%" | IncludeParents
[[Variable Types|BOOL]] ''IncludeParents''
+
|-
:True to include all the parents of the component, false to read its raw flag
+
| colspan="2" | True to include all the parents of the component, false to read its raw flag&nbsp;
 
+
|-
 
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
==Return value==
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
[[Variable Types|BOOL]]
+
|}
 
 
Returns true if the operation is a success, else false
 
  
  

Revision as of 11:41, 16 January 2023

Fc9-comp-macro.png GetCompile
Gets whether a component will be compiled or not 
Fc9-h32-icon.png - HANDLE Target
The component to read the state from 
Fc9-bool-icon.png - BOOL IncludeParents
True to include all the parents of the component, false to read its raw flag 
Fc9-bool-icon.png - BOOL Return


Detailed description

No additional information


Examples

Calling in a calculation

  • Declare a variable 'result' of type BOOL
  • Add to a calculation icon:
    result = ::Component.GetCompile(target, true)

No additional examples