Difference between revisions of "API File.RelPath"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
 
(XML import)
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
wiki page name
+
<sidebar>API Contents</sidebar>
==FileRelPath==
+
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====
 +
[[API File|File]]
 +
:[[API File|RelPath]]
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
''[[Variable types|STRING]] Filename''
+
[[Variable Types|STRING]] ''Filename''
 
:The absolute file path
 
:The absolute file path
  
===Return value===
 
[[Variable types|STRING]]
 
  
No additional information
+
==Return value==
 +
[[Variable Types|STRING]]
 +
 
 +
''<span style="color:red;">No additional information</span>''
 +
 
  
===Detailed description===
+
==Detailed description==
''No additional information''
+
''<span style="color:red;">No additional information</span>''
  
===Examples===
+
 
====Calling in a calculation:====
+
==Examples==
 +
===Calling in a calculation===
 
* Declare a variable 'result' of type STRING
 
* Declare a variable 'result' of type STRING
* Add to a calculation icon: result = ::File.RelPath("filename")
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.RelPath("filename")</pre>
 +
 
 +
''<span style="color:red;">No additional examples</span>''

Latest revision as of 15:57, 16 January 2014

<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")

No additional examples