API File.AbsPath: Difference between revisions
XML import |
XML import |
||
| Line 3: | Line 3: | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
===Class hierarchy===[[API File|File]] | ====Class hierarchy==== | ||
[[API File|File]] | |||
:[[API File|AbsPath]] | :[[API File|AbsPath]] | ||
</div> | </div> | ||
| Line 9: | Line 10: | ||
==Parameters== | ==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''' | ||
| Line 19: | Line 20: | ||
[[Variable types|STRING]] | [[Variable types|STRING]] | ||
No additional information | ''<span style="color:red;">No additional information</span>'' | ||
==Detailed description== | ==Detailed description== | ||
''No additional information'' | ''<span style="color:red;">No additional information</span>'' | ||
==Examples== | ==Examples== | ||
| Line 28: | Line 32: | ||
* Declare a variable 'result' of type STRING | * Declare a variable 'result' of type STRING | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.AbsPath("filename", owner)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.AbsPath("filename", owner)</pre> | ||
''<span style="color:red;">No additional information</span>'' | |||
Revision as of 22:11, 11 May 2013
<sidebar>API contents</sidebar> Gets an absolute path from a relative filename
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 information