Difference between revisions of "API Expand.MacroHead"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| Line 2: | Line 2: | ||
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=== | ||
| + | :Expand | ||
| + | ::MacroHead | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
''[[Variable types|STRING]] Source'' | ''[[Variable types|STRING]] Source'' | ||
:The macro name to expand | :The macro name to expand | ||
| Line 22: | Line 28: | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
| − | + | ==Return value== | |
[[Variable types|STRING]] | [[Variable types|STRING]] | ||
No additional information | No additional information | ||
| − | + | ==Detailed description== | |
''No additional information'' | ''No additional information'' | ||
| − | + | ==Examples== | |
| − | + | ===Calling in a calculation=== | |
* Declare a variable 'result' of type STRING | * Declare a variable 'result' of type STRING | ||
| − | * Add to a calculation icon: <pre class="brush:[ | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Expand.MacroHead("source", "expandedname", owner, true, false)</pre> |
Revision as of 17:06, 11 May 2013
<sidebar>API contents</sidebar> Expands a macro name to the code generated for the header of that macro
Class hierarchy
- Expand
- MacroHead
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)
