Difference between revisions of "API Expand.MacroHead"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| Line 3: | Line 3: | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
| − | ===Class hierarchy===[[API Expand|Expand]] | + | ====Class hierarchy==== |
| + | [[API Expand|Expand]] | ||
:[[API Expand|MacroHead]] | :[[API Expand|MacroHead]] | ||
</div> | </div> | ||
| Line 9: | Line 10: | ||
==Parameters== | ==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''' | ||
| Line 30: | Line 31: | ||
[[Variable types|STRING]] | [[Variable types|STRING]] | ||
| − | No additional information | + | ''<span style="color:red;">No additional information</span>'' |
| + | |||
| + | |||
==Detailed description== | ==Detailed description== | ||
| − | ''No additional information'' | + | ''<span style="color:red;">No additional information</span>'' |
| + | |||
==Examples== | ==Examples== | ||
| Line 39: | Line 43: | ||
* Declare a variable 'result' of type STRING | * Declare a variable 'result' of type STRING | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Expand.MacroHead("source", "expandedname", owner, true, false)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Expand.MacroHead("source", "expandedname", owner, true, false)</pre> | ||
| + | |||
| + | ''<span style="color:red;">No additional information</span>'' | ||
Revision as of 22:10, 11 May 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
