Difference between revisions of "API Tree.GetSubValue"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
(XML import)
Line 2: Line 2:
 
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===
 +
: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
Line 10: Line 16:
 
:The name of the sub-item in Object
 
:The name of the sub-item in Object
  
===Return value===
+
==Return value==
 
[[Variable types|STRING]]
 
[[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===
+
==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.GetSubValue(object, "subname")</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Tree.GetSubValue(object, "subname")</pre>

Revision as of 20:36, 11 May 2013

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