Difference between revisions of "API File.AbsPath"

From Flowcode Help
Jump to navigationJump to search
(XML import of updated API docs)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AbsPath'''
 +
|-
 +
| colspan="2" | Gets an absolute path from a relative filename 
 +
|-
 +
|-
 +
| 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 
 +
|-
 +
| 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 
 +
|-
 +
| 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''
 +
|}
  
  
<sidebar>API contents</sidebar>
+
==Detailed description==
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
 
 
 
[[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]]
 
  
''<span style="color:red;">No additional information</span>''
 
 
 
==Detailed description==
 
''<span style="color:red;">No additional information</span>''
 
  
  
Line 34: Line 30:
 
* 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 examples</span>''
 

Latest revision as of 11:55, 16 January 2023

Fc9-comp-macro.png AbsPath
Gets an absolute path from a relative filename 
Fc9-string-icon.png - STRING Filename
The path of the file relative to the project file 
Fc9-h32-icon.png - HANDLE Owner
A component that owns the file if it is a resource 
Fc9-string-icon.png - 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)