Difference between revisions of "API Expand.MacroBody"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(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|MacroBody]]
 
:[[API Expand|MacroBody]]
 
</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|BYTE]] Indent''
+
[[Variable types|BYTE]] ''Indent''
 
: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'''
Line 23: Line 24:
 
[[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 32: Line 36:
 
* 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.MacroBody("source", owner, indent)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Expand.MacroBody("source", owner, indent)</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 body of that macro

Class hierarchy

Expand

MacroBody

Parameters

STRING Source

The macro name to expand

HANDLE Owner

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

BYTE Indent

Tab-indent to generate the code at
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.MacroBody("source", owner, indent)

No additional information