Difference between revisions of "API Tree.GetSubValue"

From Flowcode Help
Jump to navigationJump to search
(XML import API changes)
(XML Import to change Variable types into Variable Types)
Line 10: Line 10:
  
 
==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==
 
==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

Revision as of 11:09, 10 June 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")

No additional information