Difference between revisions of "API Tree.StepSubName"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
 
Updates the object to point to the named attribute, if any
 
Updates the object to point to the named attribute, if any
  
 
<div style="width:25%; float:right" class="toc">
 
<div style="width:25%; float:right" class="toc">
===Class hierarchy===[[API |API ]]
+
====Class hierarchy====
:[[API Tree|Tree]]
+
[[API Tree|Tree]]
::StepSubName
+
:[[API Tree|StepSubName]]
 
</div>
 
</div>
 
__TOC__
 
__TOC__
  
 
==Parameters==
 
==Parameters==
''[[Variable types|HANDLE]] Object''
+
[[Variable Types|HANDLE]] ''Object''
 +
:The object containing sub-items to step to the first named item of
 
:''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
 
  
''[[Variable types|STRING]] SubName''
+
[[Variable Types|STRING]] ''SubName''
 
:The name to find the item of
 
:The name to find the item of
 +
  
 
==Return value==
 
==Return value==
 
''This call does not return a value''
 
''This call does not return a value''
 +
  
 
==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 examples</span>''

Latest revision as of 15:58, 16 January 2014

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

Class hierarchy

Tree

StepSubName

Parameters

HANDLE Object

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

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 examples