Difference between revisions of "API Tree.GetName"

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
(XML import)
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
 
Gets the name of the given object
 
Gets the name of the given object
  
 +
<div style="width:25%; float:right" class="toc">
 +
====Class hierarchy====
 +
[[API Tree|Tree]]
 +
:[[API Tree|GetName]]
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
''[[Variable types|HANDLE]] Object''
+
[[Variable Types|HANDLE]] ''Object''
 
:The object to get the name of
 
:The object to get the name of
  
===Return value===
+
 
[[Variable types|STRING]]
+
==Return value==
 +
[[Variable Types|STRING]]
  
 
Returns the name of the given object
 
Returns the 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: result = ::Tree.GetName(object)
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Tree.GetName(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 name of the given object

Class hierarchy

Tree

GetName

Parameters

HANDLE Object

The object to get the name of


Return value

STRING

Returns the 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.GetName(object)

No additional examples