API Expand.VarName: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	VarName
Expands a string to the name of a global variable used in the generated code
- STRING	Source
The variable name to expand
- HANDLE	Owner
A component that owns the variable
- BOOL	SizeName
Set true to return the expanded size define
- BOOL	FullLine
Set true to expand to a full declaration, else just the name
- STRING	Return

Detailed description

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.

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.

SizeName	FullLine	Result
false	false	`FCV_TESTVAR`
true	false	`FCVsz_TESTVAR`
false	true	`MX_UINT8 FCV_TESTVAR[FCVsz_TESTVAR]`
true	true	`#define FCVsz_TESTVAR 16`

Examples

Calling in a calculation

Declare a variable 'result' of type STRING

Add to a calculation icon:

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

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Expands a string to the name of a global variable used in the generated code
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''VarName'''
+|-
+| colspan="2" | Expands a string to the name of a global variable used in the generated code&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Source
+|-
+| colspan="2" | The variable name to expand&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Owner
+|-
+| colspan="2" | A component that owns the variable&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | SizeName
+|-
+| colspan="2" | Set true to return the expanded size define&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | FullLine
+|-
+| colspan="2" | Set true to expand to a full declaration, else just the name&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 Expand|Expand]]
-:[[API Expand|VarName]]
-</div>
-__TOC__
-==Parameters==
+==Detailed description==
-[[Variable types|STRING]] ''Source''
+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.
-:The variable name to expand
-[[Variable types|HANDLE]] ''Owner''
-:A component that owns the variable
-:''The default value for this parameter is: '''''this'''
-[[Variable types|BOOL]] ''SizeName''
+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.
-:Set true to return the expanded size define
-==Return value==
-[[Variable types|STRING]]
-''<span style="color:red;">No additional information</span>''
+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"
+|-
-==Detailed description==
+! SizeName
-''<span style="color:red;">No additional information</span>''
+! 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 34: / Line 68: @@
 ===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 information</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation