Difference between revisions of "API Tree.GetValue"

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

Class hierarchy

Tree

GetValue

Parameters

HANDLE Object

The object to get the value text of


Return value

STRING

Returns the value of the given object, if available


Detailed description

No additional information


Examples

Calling in a calculation

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

No additional examples