Difference between revisions of "API Tree.GetPath"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
(XML import)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
 
Gets the full '.' separated name of the given object
 
Gets the full '.' separated name of the given object
  
 +
<div style="width:25%; float:right" class="toc">
 +
====Class hierarchy====
 +
[[API Tree|Tree]]
 +
:[[API Tree|GetPath]]
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
''[[Variable types|HANDLE]] Object''
+
[[Variable Types|HANDLE]] ''Object''
 
:The object to find the path of
 
:The object to find the path of
  
===Return value===
+
 
[[Variable types|STRING]]
+
==Return value==
 +
[[Variable Types|STRING]]
  
 
Returns the full '.' separated name of the given object
 
Returns the full '.' separated name of the given object
  
===Detailed description===
 
''No additional information''
 
  
===Examples===
+
==Detailed description==
====Calling in a calculation====
+
''<span style="color:red;">No additional information</span>''
 +
 
 +
 
 +
==Examples==
 +
===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 = ::Tree.GetPath(object)</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Tree.GetPath(object)</pre>
 +
 
 +
''<span style="color:red;">No additional examples</span>''

Latest revision as of 15:58, 16 January 2014

<sidebar>API Contents</sidebar> Gets the full '.' separated name of the given object

Class hierarchy

Tree

GetPath

Parameters

HANDLE Object

The object to find the path of


Return value

STRING

Returns the full '.' separated name of the given object


Detailed description

No additional information


Examples

Calling in a calculation

  • Declare a variable 'result' of type STRING
  • Add to a calculation icon:
    result = ::Tree.GetPath(object)

No additional examples