API File.AbsPath: Difference between revisions
XML import of API auto-gen |
XML import |
||
| Line 2: | Line 2: | ||
Gets an absolute path from a relative filename | Gets an absolute path from a relative filename | ||
<div style="width:25%; float:right" class="toc"> | |||
===Class hierarchy=== | |||
:File | |||
::AbsPath | |||
</div> | |||
__TOC__ | |||
==Parameters== | |||
''[[Variable types|STRING]] Filename'' | ''[[Variable types|STRING]] Filename'' | ||
:The path of the file relative to the project file | :The path of the file relative to the project file | ||
| Line 11: | Line 17: | ||
:''The default value for this parameter is: '''''this''' | :''The default value for this parameter is: '''''this''' | ||
==Return value== | |||
[[Variable types|STRING]] | [[Variable types|STRING]] | ||
No additional information | No additional information | ||
==Detailed description== | |||
''No additional information'' | ''No additional information'' | ||
==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 = ::File.AbsPath("filename", owner)</pre> | ||
Revision as of 21:13, 11 May 2013
<sidebar>API contents</sidebar> Gets an absolute path from a relative filename
Class hierarchy
- File
- AbsPath
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)