Difference between revisions of "API Tree.CountNamedChildren"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
(XML import)
Line 2: Line 2:
 
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===
 +
: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
Line 10: Line 16:
 
:The name of the child that must match
 
:The name of the child that must match
  
===Return value===
+
==Return value==
 
[[Variable types|ULONG]]
 
[[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===
+
==Detailed description==
 
''No additional information''
 
''No additional information''
  
===Examples===
+
==Examples==
====Calling in a calculation====
+
===Calling in a calculation===
 
* Declare a variable 'result' of type ULONG
 
* Declare a variable 'result' of type ULONG
* Add to a calculation icon: <pre class="brush:[C]">result = ::Tree.CountNamedChildren(object, "targetname")</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Tree.CountNamedChildren(object, "targetname")</pre>

Revision as of 21:07, 11 May 2013

<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")