API Expand.MacroHead: Difference between revisions

Revision as of 11:41, 16 January 2023

	MacroHead
Expands a macro name to the code generated for the header of that macro
- STRING	Source
The macro name to expand
- STRING	ExpandedName
Result of Expand.MacroName(), empty for default
- HANDLE	Owner
A component that owns the macro
- BOOL	AddHead
Add the macro name
- BOOL	AddLocals
Tab-indent to generate the code at
- STRING	Return

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

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Expands a macro name to the code generated for the header of that macro
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-<div style="width:25%; float:right" class="toc">
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''MacroHead'''
-====Class hierarchy====
+|-
-[[API Expand|Expand]]
+| colspan="2" | Expands a macro name to the code generated for the header of that macro&nbsp;
-:[[API Expand|MacroHead]]
+|-
-</div>
+|-
-__TOC__
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Source
-==Parameters==
+|-
-[[Variable Types|STRING]] ''Source''
+| colspan="2" | The macro name to expand&nbsp;
-:The macro name to expand
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
-[[Variable Types|STRING]] ''ExpandedName''
+| width="90%" | ExpandedName
-:Result of Expand.MacroName(), empty for default
+|-
+| colspan="2" | Result of Expand.MacroName(), empty for default&nbsp;
-[[Variable Types|HANDLE]] ''Owner''
+|-
-:A component that owns the macro
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-:''The default value for this parameter is: '''''this'''
+| width="90%" | Owner
+|-
-[[Variable Types|BOOL]] ''AddHead''
+| colspan="2" | A component that owns the macro&nbsp;
-:Add the macro name
+|-
-:''The default value for this parameter is: '''''0'''
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | AddHead
-[[Variable Types|BOOL]] ''AddLocals''
+|-
-:Tab-indent to generate the code at
+| colspan="2" | Add the macro name&nbsp;
-:''The default value for this parameter is: '''''0'''
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | AddLocals
-==Return value==
+|-
-[[Variable Types|STRING]]
+| colspan="2" | Tab-indent to generate the code at&nbsp;
+|-
-''<span style="color:red;">No additional information</span>''
+| 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''
+|}

Wiki bot (talk | contribs)

Revision as of 11:41, 16 January 2023

Detailed description

Examples

Calling in a calculation