Difference between revisions of "API Expand.MacroBody"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
 
Expands a macro name to the code generated for the body of that macro
 
Expands a macro name to the code generated for the body of that macro
  
 
<div style="width:25%; float:right" class="toc">
 
<div style="width:25%; float:right" class="toc">
===Class hierarchy===
+
====Class hierarchy====
:Expand
+
[[API Expand|Expand]]
::MacroBody
+
:[[API Expand|MacroBody]]
 
</div>
 
</div>
 
__TOC__
 
__TOC__
  
 
==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'''
 +
  
 
==Return value==
 
==Return value==
[[Variable types|STRING]]
+
[[Variable Types|STRING]]
 +
 
 +
''<span style="color:red;">No additional information</span>''
  
No additional information
 
  
 
==Detailed description==
 
==Detailed description==
''No additional information''
+
''<span style="color:red;">No additional information</span>''
 +
 
  
 
==Examples==
 
==Examples==
Line 33: 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 examples</span>''

Latest revision as of 15:57, 16 January 2014

<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 examples