Node::Traverse

Background

This method provides a general database hierarchy traversal routine. The method can traverse all nodes in the hierarchy, and issue a user defined callback at each node. The traversal method has several options, specified by the TraverseCallBack_Flags enumeration. Additionally, this traversal method supports types that are abstracted or not directly available to the developer, or dynamically linked data types, such as plug-in data types. Subclasses may override this method to implement traversal modifications.

Prototype

virtual int Traverse( TraverseCallback * pCB )

Parameters

TraverseCallback * pCB: A TraverseCallback, or subclass, object, which defines parameters and a callback method to use while traversing the database.

Return Value

The return value is a TraverseCallback_Codes enumeration value indicating if, and how, traversal must proceed after the callback.