Difference between revisions of "API Component.GetCompile"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
(One intermediate revision by the same user not shown)
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]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetCompile'''
 +
|-
 +
| colspan="2" | Gets whether a component will be compiled or not&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Target
 +
|-
 +
| colspan="2" | The component to read the state from&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | IncludeParents
 +
|-
 +
| 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
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
<div style="width:25%; float:right" class="toc">
 
−
====Class hierarchy====
 
−
[[API Component|Component]]
 
−
:[[API Component|GetCompile]]
 
−
</div>
 
−
__TOC__
 
−
 
−
==Parameters==
 
−
[[Variable Types|HANDLE]] ''Target''
 
−
:The component to read the state from
 
−
:''The default value for this parameter is: '''''this'''
 
−
 
−
[[Variable Types|BOOL]] ''IncludeParents''
 
−
:True to include all the parents of the component, false to read its raw flag
 
−
 
−
 
−
==Return value==
 
−
[[Variable Types|BOOL]]
 
−
 
−
Returns true if the operation is a success, else false
 
  
 +
==Detailed description==
  
−
==Detailed description==
 
−
''<span style="color:red;">No additional information</span>''
 
  
  
Line 32: Line 30:
 
* Declare a variable 'result' of type BOOL
 
* Declare a variable 'result' of type BOOL
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetCompile(target, true)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetCompile(target, true)</pre>
−
 
−
''<span style="color:red;">No additional examples</span>''
 

Latest revision as of 11:54, 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

Examples

Calling in a calculation

  • Declare a variable 'result' of type BOOL
  • Add to a calculation icon: 
    result = ::Component.GetCompile(target, true)
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_Component.GetCompile&oldid=30148"