API File.AbsPath: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	AbsPath
Gets an absolute path from a relative filename
- 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
- STRING	Return

Detailed description

Examples

Calling in a calculation

Declare a variable 'result' of type STRING

Add to a calculation icon:

result = ::File.AbsPath("filename", owner)

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Gets an absolute path from a relative filename
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''AbsPath'''
+|-
+| colspan="2" | Gets an absolute path from a relative filename&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Filename
+|-
+| colspan="2" | The path of the file relative to the project file&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Owner
+|-
+| colspan="2" | A component that owns the file if it is a resource&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-===Parameters===
+==Detailed description==
-''[[Variable types|STRING]] Filename''
-: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
-:''The default value for this parameter is: '''''this'''
-===Return value===
-[[Variable types|STRING]]
-No additional information
+==Examples==
+===Calling in a calculation===
-===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)
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.AbsPath("filename", owner)</pre>

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation