Difference between revisions of "API Tree.GetSubValue"

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 a named sub-item of the given object, if available
 
Gets the value of a named sub-item of the given object, if available
  
 +
<div style="width:25%; float:right" class="toc">
 +
====Class hierarchy====
 +
[[API Tree|Tree]]
 +
:[[API Tree|GetSubValue]]
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
''[[Variable types|HANDLE]] Object''
+
[[Variable Types|HANDLE]] ''Object''
 
:The object to get a sub-items value from
 
:The object to get a sub-items value from
  
''[[Variable types|STRING]] SubName''
+
[[Variable Types|STRING]] ''SubName''
 
:The name of the sub-item in Object
 
:The name of the sub-item in Object
  
===Return value===
+
 
[[Variable types|STRING]]
+
==Return value==
 +
[[Variable Types|STRING]]
  
 
Returns the value of a named sub-item of the given object, if available
 
Returns the value of a named sub-item 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.GetSubValue(object, "subname")
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Tree.GetSubValue(object, "subname")</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 a named sub-item of the given object, if available

Class hierarchy

Tree

GetSubValue

Parameters

HANDLE Object

The object to get a sub-items value from

STRING SubName

The name of the sub-item in Object


Return value

STRING

Returns the value of a named sub-item 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.GetSubValue(object, "subname")

No additional examples