Difference between revisions of "API Expand.MacroBody"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
(XML import)
Line 2: Line 2:
 
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">
 +
===Class hierarchy===
 +
:Expand
 +
::MacroBody
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
 
''[[Variable types|STRING]] Source''
 
''[[Variable types|STRING]] Source''
 
:The macro name to expand
 
:The macro name to expand
Line 15: Line 21:
 
:''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]]
  
 
No additional information
 
No additional information
  
===Detailed description===
+
==Detailed description==
 
''No additional information''
 
''No additional information''
  
===Examples===
+
==Examples==
====Calling in a calculation====
+
===Calling in a calculation===
 
* Declare a variable 'result' of type STRING
 
* Declare a variable 'result' of type STRING
* Add to a calculation icon: <pre class="brush:[C]">result = ::Expand.MacroBody("source", owner, indent)</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Expand.MacroBody("source", owner, indent)</pre>

Revision as of 17:06, 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)