Jump to content

API Expand.MacroTail: Difference between revisions

From Flowcode Help
Admin (talk | contribs)
XML import
Admin (talk | contribs)
XML import
Line 3: Line 3:


<div style="width:25%; float:right" class="toc">
<div style="width:25%; float:right" class="toc">
===Class hierarchy===[[API Expand|Expand]]
====Class hierarchy====
[[API Expand|Expand]]
:[[API Expand|MacroTail]]
:[[API Expand|MacroTail]]
</div>
</div>
Line 9: Line 10:


==Parameters==
==Parameters==
''[[Variable types|STRING]] Source''
[[Variable types|STRING]] ''Source''
:The macro name to expand
:The macro name to expand


''[[Variable types|HANDLE]] Owner''
[[Variable types|HANDLE]] ''Owner''
:A component that owns the macro
:A component that owns the macro
:''The default value for this parameter is: '''''this'''
:''The default value for this parameter is: '''''this'''


''[[Variable types|BOOL]] AddLocals''
[[Variable types|BOOL]] ''AddLocals''
:Tab-indent to generate the code at
:Tab-indent to generate the code at
:''The default value for this parameter is: '''''0'''
:''The default value for this parameter is: '''''0'''


''[[Variable types|BOOL]] AddTail''
[[Variable types|BOOL]] ''AddTail''
:Add the macro tail close
:Add the macro tail close
:''The default value for this parameter is: '''''0'''
:''The default value for this parameter is: '''''0'''
Line 27: Line 28:
[[Variable types|STRING]]
[[Variable types|STRING]]


No additional information
''<span style="color:red;">No additional information</span>''
 
 


==Detailed description==
==Detailed description==
''No additional information''
''<span style="color:red;">No additional information</span>''
 


==Examples==
==Examples==
Line 36: Line 40:
* Declare a variable 'result' of type STRING
* Declare a variable 'result' of type STRING
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Expand.MacroTail("source", owner, false, true)</pre>
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Expand.MacroTail("source", owner, false, true)</pre>
''<span style="color:red;">No additional information</span>''

Revision as of 22:10, 11 May 2013

<sidebar>API contents</sidebar> Expands a macro name to the code generated for the tail of that macro

Class hierarchy

Expand

MacroTail

Parameters

STRING Source

The macro name to expand

HANDLE Owner

A component that owns the macro
The default value for this parameter is: this

BOOL AddLocals

Tab-indent to generate the code at
The default value for this parameter is: 0

BOOL AddTail

Add the macro tail close
The default value for this parameter is: 0

Return value

STRING

No additional information


Detailed description

No additional information


Examples

Calling in a calculation

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

No additional information