Difference between revisions of "API Expand.PathName"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| (12 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Expands a string using the built-in pathname expansion variables | Expands a string using the built-in pathname expansion variables | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ====Class hierarchy==== | ||
| + | [[API Expand|Expand]] | ||
| + | :[[API Expand|PathName]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
| − | + | [[Variable Types|STRING]] ''Source'' | |
:The text to expand | :The text to expand | ||
| − | |||
| − | |||
| − | + | ==Return value== | |
| + | [[Variable Types|STRING]] | ||
| − | + | The full expanded pathname. | |
| − | |||
| − | === | + | |
| − | ====Calling in a calculation | + | ==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" | ||
| + | |- | ||
| + | !width="25%"|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 | ||
| + | |} | ||
| + | |||
| + | |||
| + | ==Examples== | ||
| + | ===Calling in a calculation=== | ||
* Declare a variable 'result' of type STRING | * Declare a variable 'result' of type STRING | ||
| − | * Add to a calculation icon: <pre class="brush:[ | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Expand.PathName("source")</pre> |
| + | |||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Expands a string using the built-in pathname expansion variables
Contents
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
