Jump to content

API Expand.MacroTail: Difference between revisions

From Flowcode Help
JonnyW (talk | contribs)
XML import API changes
JonnyW (talk | contribs)
XML Import to change Variable types into Variable Types
Line 10: Line 10:


==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|BOOL]] ''AddLocals''
[[Variable Types|BOOL]] ''AddLocals''
: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'''


[[Variable types|BOOL]] ''AddTail''
[[Variable Types|BOOL]] ''AddTail''
:Add the macro tail close
:Add the macro tail close
:''The default value for this parameter is: '''''0'''
:''The default value for this parameter is: '''''0'''
Line 27: Line 27:


==Return value==
==Return value==
[[Variable types|STRING]]
[[Variable Types|STRING]]


''<span style="color:red;">No additional information</span>''
''<span style="color:red;">No additional information</span>''

Revision as of 11:08, 10 June 2013

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

Class hierarchy

Expand

MacroTail

Parameters

STRING Source

The macro name to expand

HANDLE Owner

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

BOOL AddLocals

Tab-indent to generate the code at
The default value for this parameter is: 0

BOOL AddTail

Add the macro tail close
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.MacroTail("source", owner, false, true)

No additional information