API Expand.MacroHead

From Flowcode Help
Revision as of 17:06, 11 May 2013 by Admin (talk | contribs) (XML import)
Jump to navigationJump to search

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