API Expand.MacroHead: Difference between revisions

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

Expand

MacroHead

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

No additional information

No additional information

Add to a calculation icon:

result = ::Expand.MacroHead("source", "expandedname", owner, true, false)

@@ Line 2: / Line 2: @@
 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===
+==Parameters==
 ''[[Variable types|STRING]] Source''
 :The macro name to expand
@@ Line 22: / Line 28: @@
 :''The default value for this parameter is: '''''0'''
-===Return value===
+==Return value==
 [[Variable types|STRING]]
 No additional information
-===Detailed description===
+==Detailed description==
 ''No additional information''
-===Examples===
+==Examples==
-====Calling in a calculation====
+===Calling in a calculation===
 * Declare a variable 'result' of type STRING
-* Add to a calculation icon: <pre class="brush:[C]">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>