Difference between revisions of "API Tree.GetPath"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
(XML import)
Line 2: Line 2:
 
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===
 +
: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===
+
==Return value==
 
[[Variable types|STRING]]
 
[[Variable types|STRING]]
  
 
Returns the full '.' separated name of the given object
 
Returns the full '.' separated name of the given object
  
===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 = ::Tree.GetPath(object)</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Tree.GetPath(object)</pre>

Revision as of 19:36, 11 May 2013

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