Difference between revisions of "API Expand.MacroHead"
From Flowcode Help
Jump to navigationJump to search (XML import API changes) |
(XML Import to change Variable types into Variable Types) |
||
| Line 10: | Line 10: | ||
==Parameters== | ==Parameters== | ||
| − | [[Variable | + | [[Variable Types|STRING]] ''Source'' |
:The macro name to expand | :The macro name to expand | ||
| − | [[Variable | + | [[Variable Types|STRING]] ''ExpandedName'' |
:Result of Expand.MacroName(), empty for default | :Result of Expand.MacroName(), empty for default | ||
| − | [[Variable | + | [[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 | + | [[Variable Types|BOOL]] ''AddHead'' |
:Add the macro name | :Add the macro name | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
| − | [[Variable | + | [[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''' | ||
| Line 30: | Line 30: | ||
==Return value== | ==Return value== | ||
| − | [[Variable | + | [[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 header of that macro
Contents
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
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 information
