API Expand.MacroTail: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	MacroTail
Expands a macro name to the code generated for the tail of that macro
- STRING	Source
The macro name to expand
- HANDLE	Owner
A component that owns the macro
- BOOL	AddLocals
Tab-indent to generate the code at
- BOOL	AddTail
Add the macro tail close
- STRING	Return

Detailed description

Examples

Calling in a calculation

Declare a variable 'result' of type STRING

Add to a calculation icon:

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

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Expands a macro name to the code generated for the tail of that macro
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''MacroTail'''
+|-
+| colspan="2" | Expands a macro name to the code generated for the tail of that macro&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Source
+|-
+| colspan="2" | The macro name to expand&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Owner
+|-
+| colspan="2" | A component that owns the macro&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | AddLocals
+|-
+| colspan="2" | Tab-indent to generate the code at&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | AddTail
+|-
+| colspan="2" | Add the macro tail close&nbsp;
+|-
+| 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''
+|}
-<div style="width:25%; float:right" class="toc">
-===Class hierarchy===[[API |API ]]
-:[[API Expand|Expand]]
-::MacroTail
-</div>
-__TOC__
-==Parameters==
+==Detailed description==
-''[[Variable types|STRING]] Source''
-:The macro name to expand
-''[[Variable types|HANDLE]] Owner''
-:A component that owns the macro
-:''The default value for this parameter is: '''''this'''
-''[[Variable types|BOOL]] AddLocals''
-:Tab-indent to generate the code at
-:''The default value for this parameter is: '''''0'''
-''[[Variable types|BOOL]] AddTail''
-:Add the macro tail close
-:''The default value for this parameter is: '''''0'''
-==Return value==
-[[Variable types|STRING]]
-No additional information
-==Detailed description==
-''No additional information''
 ==Examples==

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation