GetChildTraverse Data Member Function

Using the <Node> submitted to this function as the root, performs a breadth-first search and populates a <List> object with all the <Node> objects of the indicated type. Optionally, this function can clone the child <Node> objects and transfer ownership of them to the <List>.

Prototype

int32 GetChildTraverse( Node p_oSearchRoot, List p_lNodes, TypeInformation p_oNodeTypeInformation, int32 p_nClone )

Parameters

Parameter Type Parameter Name Documentation
<Node>p_oSearchRootA pointer to a <Node> representing the search root.
<List>p_lNodesA pointer to a <List> object that will containing owning ( or non-owning ) pointers to the child <Node> objects that match the indicated <TypeInformation>.
TypeInformationp_oNodeTypeInformationA pointer to a <TypeInformation> object representing the type of <Node> with which to populate the <List> object.
int32p_nCloneAn <int32> where 0 means 'do not clone and transfer ownership to the <List>' and 1 means 'clone matching <Node> objects, detach them from the Model, and transfer ownership of the cloned <Node> objects to the <List>'.

Examples

Copy Text To Clipboard

None published. Please look for an example in the Scenome Scripting Language code base.