Difference between revisions of "API Expand.MacroHead"
From Flowcode Help
Jump to navigationJump to search (XML import) |
|||
| (10 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| − | Expands a macro name to the code generated for the header of that macro | + | |- |
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''MacroHead''' | ||
| + | |- | ||
| + | | colspan="2" | Expands a macro name to the code generated for the header of that macro | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
| + | | width="90%" | Source | ||
| + | |- | ||
| + | | colspan="2" | The macro name to expand | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
| + | | width="90%" | ExpandedName | ||
| + | |- | ||
| + | | colspan="2" | Result of Expand.MacroName(), empty for default | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | Owner | ||
| + | |- | ||
| + | | colspan="2" | A component that owns the macro | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" | AddHead | ||
| + | |- | ||
| + | | colspan="2" | Add the macro name | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" | AddLocals | ||
| + | |- | ||
| + | | colspan="2" | Tab-indent to generate the code at | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | == | + | ==Detailed description== |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Examples== | ==Examples== | ||
Latest revision as of 11:55, 16 January 2023
|
MacroHead |
| Expands a macro name to the code generated for the header of that macro | |
 - STRING
|
Source |
| The macro name to expand | |
| - STRING
|
ExpandedName |
| Result of Expand.MacroName(), empty for default | |
 - HANDLE
|
Owner |
| A component that owns the macro | |
 - BOOL
|
AddHead |
| Add the macro name | |
| - BOOL
|
AddLocals |
| Tab-indent to generate the code at | |
| - STRING
|
Return |
Detailed description
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)
