Difference between revisions of "API File.RelPath"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
(XML import)
Line 2: Line 2:
 
Gets an relative path from an absolute filename
 
Gets an relative path from an absolute filename
  
 +
<div style="width:25%; float:right" class="toc">
 +
===Class hierarchy===
 +
:File
 +
::RelPath
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
 
''[[Variable types|STRING]] Filename''
 
''[[Variable types|STRING]] Filename''
 
:The absolute file path
 
:The absolute file path
  
===Return value===
+
==Return value==
 
[[Variable types|STRING]]
 
[[Variable types|STRING]]
  
 
No additional information
 
No additional information
  
===Detailed description===
+
==Detailed description==
 
''No additional information''
 
''No additional information''
  
===Examples===
+
==Examples==
====Calling in a calculation====
+
===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:[C]">result = ::File.RelPath("filename")</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.RelPath("filename")</pre>

Revision as of 21:13, 11 May 2013

<sidebar>API contents</sidebar> Gets an relative path from an absolute filename

Class hierarchy

File
RelPath

Parameters

STRING Filename

The absolute file path

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.RelPath("filename")