Difference between revisions of "API Expand.MacroHead"

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
(XML import of API auto-gen)
Line 33: Line 33:
 
====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: result = ::Expand.MacroHead("source", "expandedname", owner, true, false)
+
* Add to a calculation icon: <pre class="brush:[C]">result = ::Expand.MacroHead("source", "expandedname", owner, true, false)</pre>

Revision as of 15:35, 10 May 2013

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


Parameters

STRING Source

The macro name to expand

STRING ExpandedName

Result of Expand.MacroName(), empty for default

HANDLE Owner

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

BOOL AddHead

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

BOOL AddLocals

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.MacroHead("source", "expandedname", owner, true, false)