Difference between revisions of "API Tree.GetSubValue"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
|||
| (16 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| − | == | + | |- |
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetSubValue''' | ||
| + | |- | ||
| + | | colspan="2" | Gets the value of a named sub-item of the given object, if available | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | Object | ||
| + | |- | ||
| + | | colspan="2" | The object to get a sub-items value from | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
| + | | width="90%" | SubName | ||
| + | |- | ||
| + | | colspan="2" | The name of the sub-item in Object | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| − | |||
| − | |||
| − | === | + | ==Detailed description== |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | ==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> |
Latest revision as of 11:55, 16 January 2023
|
GetSubValue |
| Gets the value of a named sub-item of the given object, if available | |
 - HANDLE
|
Object |
| The object to get a sub-items value from | |
 - STRING
|
SubName |
| The name of the sub-item in Object | |
| - STRING
|
Return |
Detailed description
Examples
Calling in a calculation
- Declare a variable 'result' of type STRING
- Add to a calculation icon:
result = ::Tree.GetSubValue(object, "subname")
