API Expand.MacroName

From Flowcode Help
Jump to navigationJump to search

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

Class hierarchy

Expand

MacroName

Parameters

STRING Source

The macro name to expand

HANDLE Owner

A component that owns the macro
The default value for this parameter is: this


Return value

STRING

The full expanded macro name.


Detailed description

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 FCD_PARENT_OBJECT_TESTMACRO.


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).


Examples

Calling in a calculation

  • Declare a variable 'result' of type STRING
  • Add to a calculation icon:
    result = ::Expand.MacroName("source", owner)

No additional examples