API Tree.GetSubValue: Difference between revisions
XML import |
XML import |
||
| Line 3: | Line 3: | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
===Class hierarchy===[[API Tree|Tree]] | ====Class hierarchy==== | ||
[[API Tree|Tree]] | |||
:[[API Tree|GetSubValue]] | :[[API Tree|GetSubValue]] | ||
</div> | </div> | ||
| Line 9: | Line 10: | ||
==Parameters== | ==Parameters== | ||
[[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'' | |||
:The name of the sub-item in Object | :The name of the sub-item in Object | ||
| Line 21: | Line 22: | ||
==Detailed description== | ==Detailed description== | ||
''No additional information'' | ''<span style="color:red;">No additional information</span>'' | ||
==Examples== | ==Examples== | ||
| Line 27: | Line 29: | ||
* Declare a variable 'result' of type STRING | * Declare a variable 'result' of type STRING | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Tree.GetSubValue(object, "subname")</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Tree.GetSubValue(object, "subname")</pre> | ||
''<span style="color:red;">No additional information</span>'' | |||
Revision as of 22:10, 11 May 2013
<sidebar>API contents</sidebar> Gets the value of a named sub-item of the given object, if available
Parameters
HANDLE Object
- The object to get a sub-items value from
STRING SubName
- The name of the sub-item in Object
Return value
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