API Expand.PathName: Difference between revisions
XML import of updated API docs |
No edit summary |
||
| Line 19: | Line 19: | ||
[[Variable Types|STRING]] | [[Variable Types|STRING]] | ||
The full expanded pathname. | |||
==Detailed description== | ==Detailed description== | ||
'' | This does not resolve a pathname, for this use [[API File.AbsPath|File.AbsPath]]. What this will do is use the ''$(variable)'' syntax to expand the string using built-in variable names used in the compiler settings and other pathname fields in Flowcode. | ||
The list of variables available in this expansion are: | |||
{| class="wikitable" | |||
|- | |||
!Variable | |||
!Meaning | |||
|- | |||
|appdir | |||
|The Flowcode applications directory | |||
|- | |||
|chip | |||
|The name of the target chip, eg 16F88 | |||
|- | |||
|family | |||
|The family of the target chip, eg 16F | |||
|- | |||
|platform | |||
|The platform of the target chip, eg PIC | |||
|- | |||
|chippath | |||
|The full name of the target chip, eg PIC.16F.16F88 | |||
|- | |||
|chipalt | |||
|The alternate-name of the target chip | |||
|- | |||
|cfga | |||
|The address of the base of the config, as specified in the FCD file | |||
|- | |||
|cfgb | |||
|The number of bytes of the config specified in the FCD file | |||
|- | |||
|cfgen | |||
|Whether the user has selected to write config to the chip | |||
|- | |||
|cfg''N'' | |||
|Starting with ''cfg0'', the slot values specified in the config | |||
|- | |||
|target | |||
|The source or target file leafname, without an extension, eg ''my_project'' | |||
|- | |||
|srcdir | |||
|The directory the my-project.fcf file is located in | |||
|- | |||
|outdir | |||
|The directory output and intermediate files are sent to | |||
|} | |||
Revision as of 10:20, 17 June 2013
<sidebar>API contents</sidebar>
Expands a string using the built-in pathname expansion variables
Parameters
STRING Source
- The text to expand
Return value
The full expanded pathname.
Detailed description
This does not resolve a pathname, for this use File.AbsPath. What this will do is use the $(variable) syntax to expand the string using built-in variable names used in the compiler settings and other pathname fields in Flowcode.
The list of variables available in this expansion are:
| Variable | Meaning |
|---|---|
| appdir | The Flowcode applications directory |
| chip | The name of the target chip, eg 16F88 |
| family | The family of the target chip, eg 16F |
| platform | The platform of the target chip, eg PIC |
| chippath | The full name of the target chip, eg PIC.16F.16F88 |
| chipalt | The alternate-name of the target chip |
| cfga | The address of the base of the config, as specified in the FCD file |
| cfgb | The number of bytes of the config specified in the FCD file |
| cfgen | Whether the user has selected to write config to the chip |
| cfgN | Starting with cfg0, the slot values specified in the config |
| target | The source or target file leafname, without an extension, eg my_project |
| srcdir | The directory the my-project.fcf file is located in |
| outdir | The directory output and intermediate files are sent to |
Examples
Calling in a calculation
- Declare a variable 'result' of type STRING
- Add to a calculation icon:
result = ::Expand.PathName("source")
No additional examples