Difference between revisions of "API Expand.VarName"
From Flowcode Help
Jump to navigationJump to search (XML import of updated API docs) |
|||
| Line 26: | Line 26: | ||
[[Variable Types|STRING]] | [[Variable Types|STRING]] | ||
| − | + | The global variable name as it would exist in the generated code | |
==Detailed description== | ==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. | ||
Revision as of 17:56, 17 June 2013
<sidebar>API contents</sidebar>
Expands a string to the name of a global variable used in the generated code
Contents
Parameters
STRING Source
- The variable name to expand
HANDLE Owner
- A component that owns the variable
- The default value for this parameter is: this
BOOL SizeName
- Set true to return the expanded size define
Return value
The global variable name as it would exist in the generated code
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.
Examples
Calling in a calculation
- Declare a variable 'result' of type STRING
- Add to a calculation icon:
result = ::Expand.VarName("source", owner, false)
No additional examples
