Difference between revisions of "API Tree.StepSubName"

From Flowcode Help
Jump to navigationJump to search
(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|StepSubName]]
 
:[[API Tree|StepSubName]]
 
</div>
 
</div>
Line 9: Line 10:
  
 
==Parameters==
 
==Parameters==
''[[Variable types|HANDLE]] Object''
+
[[Variable types|HANDLE]] ''Object''
 
:''This parameter is returned back to the caller''
 
:''This parameter is returned back to the caller''
 
:The object containing sub-items to step to the first named item of
 
:The object containing sub-items to step to the first named item of
  
''[[Variable types|STRING]] SubName''
+
[[Variable types|STRING]] ''SubName''
 
:The name to find the item of
 
:The name to find the item of
  
Line 20: Line 21:
  
 
==Detailed description==
 
==Detailed description==
''No additional information''
+
''<span style="color:red;">No additional information</span>''
 +
 
  
 
==Examples==
 
==Examples==
 
===Calling in a calculation===
 
===Calling in a calculation===
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Tree.StepSubName(return_object, "subname")</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Tree.StepSubName(return_object, "subname")</pre>
 +
 +
''<span style="color:red;">No additional information</span>''

Revision as of 22:11, 11 May 2013

<sidebar>API contents</sidebar> Updates the object to point to the named attribute, if any

Class hierarchy

Tree

StepSubName

Parameters

HANDLE Object

This parameter is returned back to the caller
The object containing sub-items to step to the first named item of

STRING SubName

The name to find the item of

Return value

This call does not return a value

Detailed description

No additional information


Examples

Calling in a calculation

  • Add to a calculation icon:
    ::Tree.StepSubName(return_object, "subname")

No additional information