API Expand.VarName - Revision history

Wiki bot at 11:55, 16 January 2023

2023-01-16T11:55:19Z

Wiki bot at 11:41, 16 January 2023

2023-01-16T11:41:52Z

JonnyW: XML import

2014-01-16T15:57:47Z

XML import

JonnyW: XML import of API documentation

2013-08-09T14:27:40Z

XML import of API documentation

JonnyW at 18:08, 17 June 2013

2013-06-17T18:08:30Z

JonnyW: XML import of updated Expand.VarName

2013-06-17T18:03:42Z

XML import of updated Expand.VarName

JonnyW at 17:56, 17 June 2013

2013-06-17T17:56:49Z

JonnyW: XML import of updated API docs

2013-06-17T09:58:17Z

XML import of updated API docs

JonnyW: XML Import to change Variable types into Variable Types

2013-06-10T11:08:58Z

XML Import to change Variable types into Variable Types

JonnyW: XML import API changes

2013-05-14T13:16:02Z

XML import API changes

← Older revision		Revision as of 11:55, 16 January 2023
Line 69:		Line 69:
	* 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.VarName("source", owner, false, true)</pre>		* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Expand.VarName("source", owner, false, true)</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 global variable 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;" | '''VarName'''
-====Class hierarchy====
+|-
-[[API Expand|Expand]]
+| colspan="2" | Expands a string to the name of a global variable used in the generated code&nbsp;
-:[[API Expand|VarName]]
+|-
-</div>
+|-
-__TOC__
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Source
-==Parameters==
+|-
-[[Variable Types|STRING]] ''Source''
+| colspan="2" | The variable name to expand&nbsp;
-:The variable 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 variable
+|-
-:''The default value for this parameter is: '''''this'''
+| colspan="2" | A component that owns the variable&nbsp;
+|-
-[[Variable Types|BOOL]] ''SizeName''
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
-:Set true to return the expanded size define
+| width="90%" | SizeName
+|-
-[[Variable Types|BOOL]] ''FullLine''
+| colspan="2" | Set true to return the expanded size define&nbsp;
-:Set true to expand to a full declaration, else just the name
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | FullLine
-==Return value==
+|-
-[[Variable Types|STRING]]
+| colspan="2" | Set true to expand to a full declaration, else just the name&nbsp;
+|-
-The global variable name as it would exist in the generated code
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - 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 global variable used in the generated code		Expands a string to the name of a global variable 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 global variable used in the generated code		Expands a string to the name of a global variable used in the generated code

← Older revision		Revision as of 18:08, 17 June 2013
Line 36:		Line 36:

	Note this does not return the full expression unless ''FullLine'' is true. In this case, ''Source'' ''must'' be a valid variable name for the ''Owner'' component, as the system needs this in order to expand the variable type, array sizes and initialisers.		Note this does not return the full expression unless ''FullLine'' is true. In this case, ''Source'' ''must'' be a valid variable name for the ''Owner'' component, as the system needs this in order to expand the variable type, array sizes and initialisers.
		+
		+
		+	This is an example of what may be shown with differing ''SizeName'' and ''FullLine'' values. The sample variable is '''TestVar''', a byte array of 16 elements.
		+
		+	{\| class="wikitable"
		+	\|-
		+	! SizeName
		+	! FullLine
		+	! Result
		+	\|-
		+	\| false
		+	\| false
		+	\| <tt>FCV_TESTVAR</tt>
		+	\|-
		+	\| true
		+	\| false
		+	\| <tt>FCVsz_TESTVAR</tt>
		+	\|-
		+	\| false
		+	\| true
		+	\| <tt>MX_UINT8 FCV_TESTVAR[FCVsz_TESTVAR]</tt>
		+	\|-
		+	\| true
		+	\| true
		+	\| <tt>#define FCVsz_TESTVAR 16</tt>
		+	\|}

@@ Line 1: / Line 1: @@
 <sidebar>API contents</sidebar>
@@ Line 21: / Line 20: @@
 [[Variable Types|BOOL]] ''SizeName''
 :Set true to return the expanded size define
@@ Line 39: / Line 41: @@
 ===Calling in a calculation===
 * Declare a variable 'result' of type STRING
-* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Expand.VarName("source", owner, false)</pre>
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Expand.VarName("source", owner, false, true)</pre>
 ''<span style="color:red;">No additional examples</span>''

@@ Line 26: / Line 26: @@
 [[Variable Types|STRING]]
-''<span style="color:red;">No additional information</span>''
+The global variable name as it would exist in the generated code
 ==Detailed description==
-''<span style="color:red;">No additional information</span>''
+This expands a global variable to the name it would be given in the generated code. The size define (the size of the final dimension of the array) may be returned instead if required.