Difference between revisions of "API Tree.StepNamedIndex"

From Flowcode Help
Jump to navigationJump to search
(XML import of API documentation)
 
(2 intermediate revisions by 2 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;" | '''StepNamedIndex'''
 +
|-
 +
| colspan="2" | Updates the object to point to the Nth next (younger) sibling matching the name 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Object
 +
|-
 +
| colspan="2" | The object to update with the next found sibling 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | TargetName
 +
|-
 +
| colspan="2" | The name of the sibling to find 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" | The index to find, 0 for the first including this 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
<sidebar>API Contents</sidebar>
+
==Detailed description==
−
Updates the object to point to the Nth next (younger) sibling matching the name
 
−
 
 
−
<div style="width:25%; float:right" class="toc">
 
−
====Class hierarchy====
 
−
[[API Tree|Tree]]
 
−
:[[API Tree|StepNamedIndex]]
 
−
</div>
 
−
__TOC__
 
−
 
 
−
==Parameters==
 
−
[[Variable Types|HANDLE]] ''Object''
 
−
:The object to update with the next found sibling
 
−
:''This parameter is returned back to the caller''
 
−
 
 
−
[[Variable Types|STRING]] ''TargetName''
 
−
:The name of the sibling to find
 
−
 
 
−
[[Variable Types|LONG]] ''Index''
 
−
:The index to find, 0 for the first including this
 
−
 
 
  
−
==Return value==
 
−
''This call does not return a value''
 
−
 
−
 
−
==Detailed description==
 
−
''<span style="color:red;">No additional information</span>''
 
  
  
Line 34: Line 34:
 
===Calling in a calculation===
 
===Calling in a calculation===
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Tree.StepNamedIndex(return_object, "targetname", index)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Tree.StepNamedIndex(return_object, "targetname", index)</pre>
−
 
−
''<span style="color:red;">No additional examples</span>''
 

Latest revision as of 11:55, 16 January 2023

Fc9-comp-macro.png StepNamedIndex
Updates the object to point to the Nth next (younger) sibling matching the name 
Fc9-h32-icon.png - HANDLE Object
The object to update with the next found sibling 
Fc9-string-icon.png - STRING TargetName
The name of the sibling to find 
Fc9-s32-icon.png - LONG Index
The index to find, 0 for the first including this 
Fc9-void-icon.png - NONE Return


Detailed description

Examples

Calling in a calculation

  • Add to a calculation icon: 
    ::Tree.StepNamedIndex(return_object, "targetname", index)
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_Tree.StepNamedIndex&oldid=30279"