API Expand.VarName: Difference between revisions

Revision as of 11:41, 16 January 2023

	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)

No additional examples

@@ 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
+| 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