Difference between revisions of "API Tree.CountNamedChildren"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
 
(XML import)
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
wiki page name
+
<sidebar>API Contents</sidebar>
==TreeCountNamedChildren==
+
Returns the number of immediate children present for the object
  
Returns the number of immediate children present for the object
+
<div style="width:25%; float:right" class="toc">
----
+
====Class hierarchy====
 +
[[API Tree|Tree]]
 +
:[[API Tree|CountNamedChildren]]
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
''[[Variable types|HANDLE]] Object''
+
[[Variable Types|HANDLE]] ''Object''
 
:The object to count all the named immediate children of
 
:The object to count all the named immediate children of
  
''[[Variable types|STRING]] TargetName''
+
[[Variable Types|STRING]] ''TargetName''
 
:The name of the child that must match
 
:The name of the child that must match
  
===Return value===
+
 
[[Variable types|ULONG]]
+
==Return value==
 +
[[Variable Types|ULONG]]
  
 
Returns the number of immediate children present for the object
 
Returns the number of immediate children present for the object
  
===Detailed description===
 
''No additional information''
 
  
===Examples===
+
==Detailed description==
====Calling in a calculation:====
+
''<span style="color:red;">No additional information</span>''
 +
 
 +
 
 +
==Examples==
 +
===Calling in a calculation===
 
* Declare a variable 'result' of type ULONG
 
* Declare a variable 'result' of type ULONG
* Add to a calculation icon: result = ::Tree.CountNamedChildren(object, "targetname")
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Tree.CountNamedChildren(object, "targetname")</pre>
 +
 
 +
''<span style="color:red;">No additional examples</span>''

Latest revision as of 15:58, 16 January 2014

<sidebar>API Contents</sidebar> Returns the number of immediate children present for the object

Class hierarchy

Tree

CountNamedChildren

Parameters

HANDLE Object

The object to count all the named immediate children of

STRING TargetName

The name of the child that must match


Return value

ULONG

Returns the number of immediate children present for the object


Detailed description

No additional information


Examples

Calling in a calculation

  • Declare a variable 'result' of type ULONG
  • Add to a calculation icon:
    result = ::Tree.CountNamedChildren(object, "targetname")

No additional examples