Difference between revisions of "API Expand.MacroHead"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
(XML import) |
||
| (12 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | API | + | <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 | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ====Class hierarchy==== | ||
| + | [[API Expand|Expand]] | ||
| + | :[[API Expand|MacroHead]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
| − | + | [[Variable Types|STRING]] ''Source'' | |
:The macro name to expand | :The macro name to expand | ||
| − | + | [[Variable Types|STRING]] ''ExpandedName'' | |
:Result of Expand.MacroName(), empty for default | :Result of Expand.MacroName(), empty for default | ||
| − | + | [[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]] ''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 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''' | ||
| − | |||
| − | |||
| − | + | ==Return value== | |
| + | [[Variable Types|STRING]] | ||
| − | + | ''<span style="color:red;">No additional information</span>'' | |
| − | ''No additional information'' | ||
| − | ===Examples | + | |
| − | + | ==Detailed description== | |
| + | ''<span style="color:red;">No additional information</span>'' | ||
| + | |||
| + | |||
| + | ==Examples== | ||
| + | ===Calling in a calculation=== | ||
* Declare a variable 'result' of type STRING | * Declare a variable 'result' of type STRING | ||
| − | * Add to a calculation icon: result = ::Expand.MacroHead("source", "expandedname", owner, true, false) | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Expand.MacroHead("source", "expandedname", owner, true, false)</pre> |
| + | |||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
Latest revision as of 15:57, 16 January 2014
<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 examples
