Difference between revisions of "API Tree.GetSubValue"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <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"> | <div style="width:25%; float:right" class="toc"> | ||
| − | ===Class hierarchy===[[API | | + | ====Class hierarchy==== |
| − | :[[API Tree| | + | [[API Tree|Tree]] |
| − | + | :[[API Tree|GetSubValue]] | |
</div> | </div> | ||
__TOC__ | __TOC__ | ||
==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 | ||
| + | |||
==Return value== | ==Return value== | ||
| − | [[Variable | + | [[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'' | + | ''<span style="color:red;">No additional information</span>'' |
| + | |||
==Examples== | ==Examples== | ||
| Line 28: | Line 31: | ||
* 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 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
Contents
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 examples
