Difference between revisions of "API File.AbsPath"

From Flowcode Help
Jump to navigationJump to search
(XML import API changes)
(XML import)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
 
Gets an absolute path from a relative filename
 
Gets an absolute path from a relative filename
  
Line 10: Line 10:
  
 
==Parameters==
 
==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
  
[[Variable types|HANDLE]] ''Owner''
+
[[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 19:
  
 
==Return value==
 
==Return value==
[[Variable types|STRING]]
+
[[Variable Types|STRING]]
  
 
''<span style="color:red;">No additional information</span>''
 
''<span style="color:red;">No additional information</span>''
Line 33: Line 33:
 
* 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>''
+
''<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

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

STRING

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