Jump to content

API Expand.MacroHead: Difference between revisions

From Flowcode Help
JonnyW (talk | contribs)
XML import of updated API docs
JonnyW (talk | contribs)
XML import of API documentation
Line 1: Line 1:




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



Revision as of 14:27, 9 August 2013


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

Class hierarchy

Expand

MacroHead

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)

No additional examples