Difference between revisions of "API File.AbsPath"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
(14 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | + | <sidebar>API Contents</sidebar> | |
− | + | Gets an absolute path from a relative filename | |
− | + | <div style="width:25%; float:right" class="toc"> | |
− | + | ====Class hierarchy==== | |
+ | [[API File|File]] | ||
+ | :[[API File|AbsPath]] | ||
+ | </div> | ||
+ | __TOC__ | ||
− | + | ==Parameters== | |
− | + | [[Variable Types|STRING]] ''Filename'' | |
:The path of the file relative to the project file | :The path of the file relative to the project file | ||
− | + | [[Variable Types|HANDLE]] ''Owner'' | |
:A component that owns the file if it is a resource | :A component that owns the file if it is a resource | ||
:''The default value for this parameter is: '''''this''' | :''The default value for this parameter is: '''''this''' | ||
− | |||
− | |||
− | No additional information | + | ==Return value== |
+ | [[Variable Types|STRING]] | ||
+ | |||
+ | ''<span style="color:red;">No additional information</span>'' | ||
+ | |||
− | + | ==Detailed description== | |
− | ''No additional information'' | + | ''<span style="color:red;">No additional information</span>'' |
− | + | ||
− | + | ==Examples== | |
+ | ===Calling in a calculation=== | ||
* Declare a variable 'result' of type STRING | * Declare a variable 'result' of type STRING | ||
− | * Add to a calculation icon: result = ::File.AbsPath("filename", owner) | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.AbsPath("filename", owner)</pre> |
+ | |||
+ | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Gets an absolute path from a relative filename
Contents
Parameters
STRING Filename
- The path of the file relative to the project file
HANDLE Owner
- A component that owns the file if it is a resource
- The default value for this parameter is: this
Return value
No additional information
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type STRING
- Add to a calculation icon:
result = ::File.AbsPath("filename", owner)
No additional examples