Difference between revisions of "API Expand.MacroTail"

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Expands a macro name to the code generated for the tail of that macro
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''MacroTail'''
 +
|-
 +
| colspan="2" | Expands a macro name to the code generated for the tail of that macro&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Source
 +
|-
 +
| colspan="2" | The macro name to expand&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Owner
 +
|-
 +
| colspan="2" | A component that owns the macro&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | AddLocals
 +
|-
 +
| colspan="2" | Tab-indent to generate the code at&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | AddTail
 +
|-
 +
| colspan="2" | Add the macro tail close&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
===Parameters===
+
==Detailed description==
''[[Variable types|STRING]] Source''
 
:The macro name to expand
 
  
''[[Variable types|HANDLE]] Owner''
 
:A component that owns the macro
 
:''The default value for this parameter is: '''''this'''
 
  
''[[Variable types|BOOL]] AddLocals''
 
:Tab-indent to generate the code at
 
:''The default value for this parameter is: '''''0'''
 
  
''[[Variable types|BOOL]] AddTail''
+
==Examples==
:Add the macro tail close
+
===Calling in a calculation===
:''The default value for this parameter is: '''''0'''
 
 
 
===Return value===
 
[[Variable types|STRING]]
 
 
 
No additional information
 
 
 
===Detailed description===
 
''No additional information''
 
 
 
===Examples===
 
====Calling in a calculation====
 
 
* Declare a variable 'result' of type STRING
 
* Declare a variable 'result' of type STRING
* Add to a calculation icon: result = ::Expand.MacroTail("source", owner, false, true)
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Expand.MacroTail("source", owner, false, true)</pre>

Latest revision as of 11:55, 16 January 2023

Fc9-comp-macro.png MacroTail
Expands a macro name to the code generated for the tail of that macro 
Fc9-string-icon.png - STRING Source
The macro name to expand 
Fc9-h32-icon.png - HANDLE Owner
A component that owns the macro 
Fc9-bool-icon.png - BOOL AddLocals
Tab-indent to generate the code at 
Fc9-bool-icon.png - BOOL AddTail
Add the macro tail close 
Fc9-string-icon.png - STRING Return


Detailed description

Examples

Calling in a calculation

  • Declare a variable 'result' of type STRING
  • Add to a calculation icon:
    result = ::Expand.MacroTail("source", owner, false, true)