Description

Returns an array of all the children of the specified parent.

The getChildren command is useful in script procedures for automatically identifying the children of a node or nodes. The results are saved to a module array, which may in turn be passed to a subsequent command or procedure.

Functional area

Data retrieval

Command syntax

Syntax

getChildren parentName[-nodesOnly] [-fullPath] [-nameOnly]

Arguments

None

Flags

Name	Argument type	Exclusive to	Comments
`nodesOnly`	—	—	—
`fullPath`	—	nameOnly	—
`nameOnly`	—	fullPath	—

Return value

string array

Examples

string $mods[] = `getChildren rfoot`;
int $i; 
for( $i = 0; 
   $i < $mods.getCount(); 
   $i += 1 )        
    print( $mods[$i] );
print ($mods.getCount()); 
// In this example, a module array called "$mods" is declared
// and the children of the node "right_foot" are assigned to it. 
// The for loop iterates through the elements of the array and 
// prints each one to the interface. The last line prints the 
// value of $mods.getCount, which is an integer describing 
// the number of children that were found in this instance.

Shogun 1.14 Documentation

getChildren