API Expand.MacroName - Revision history

Wiki bot at 11:55, 16 January 2023

2023-01-16T11:55:19Z

2023-01-16T11:41:52Z

2014-01-16T15:57:46Z

XML import

2013-08-09T14:27:39Z

XML import of API documentation

2013-06-17T17:26:43Z

2013-06-17T13:31:09Z

2013-06-17T09:58:20Z

XML import of updated API docs

2013-06-10T11:08:56Z

XML Import to change Variable types into Variable Types

2013-05-14T13:16:00Z

XML import API changes

2013-05-12T21:53:52Z

XML import

← Older revision		Revision as of 11:55, 16 January 2023
Line 33:		Line 33:
	* 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.MacroName("source", owner)</pre>		* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Expand.MacroName("source", owner)</pre>
−
−	~~''<span style="color:red;">No additional examples</span>''~~

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Expands a string to the name of a macro used in the generated code
+|-
+| 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;" | '''MacroName'''
-====Class hierarchy====
+|-
-[[API Expand|Expand]]
+| colspan="2" | Expands a string to the name of a macro used in the generated code&nbsp;
-:[[API Expand|MacroName]]
+|-
-</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-h32-icon.png]] - HANDLE
-[[Variable Types|HANDLE]] ''Owner''
+| width="90%" | Owner
-:A component that owns the macro
+|-
-:''The default value for this parameter is: '''''this'''
+| colspan="2" | A component that owns the macro&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
-==Return value==
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
-[[Variable Types|STRING]]
+|}

← Older revision		Revision as of 15:57, 16 January 2014
Line 1:		Line 1:
−
−
	<sidebar>API Contents</sidebar>		<sidebar>API Contents</sidebar>
	Expands a string to the name of a macro used in the generated code		Expands a string to the name of a macro used in the generated code

← Older revision		Revision as of 14:27, 9 August 2013
Line 1:		Line 1:


−	<sidebar>API ~~contents~~</sidebar>	+	<sidebar>API Contents</sidebar>
	Expands a string to the name of a macro used in the generated code		Expands a string to the name of a macro used in the generated code

← Older revision		Revision as of 17:26, 17 June 2013
Line 30:		Line 30:


−	This should only be called during compilation if it is to ~~be 100% reliable~~ as compilation will calculate the static linkage of a macro at this point (a component may be redirected to some pre-existing and identical function generated by some other component in order to save space on the target).	+	This should only be called during compilation if it is to match up with the generated code as compilation will calculate the static linkage of a macro at this point (a component may be redirected to some pre-existing and identical function generated by some other component in order to save space on the target).

@@ Line 23: / Line 23: @@
 [[Variable Types|STRING]]
-''<span style="color:red;">No additional information</span>''
+The full expanded macro name.
 ==Detailed description==
-''<span style="color:red;">No additional information</span>''
+This takes a macro name owned by the specified ''Owner'' component and returns the name of the macro as it would be added to the downloaded code. For example the macro ''TestMacro'' may be expanded to <tt>FCD_PARENT_OBJECT_TESTMACRO</tt>.

@@ Line 1: / Line 1: @@
 <sidebar>API contents</sidebar>
 Expands a string to the name of a macro used in the generated code
@@ Line 33: / Line 35: @@
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Expand.MacroName("source", owner)</pre>
-''<span style="color:red;">No additional information</span>''
+''<span style="color:red;">No additional examples</span>''