ProElemtreeElementVisit

Category Feature element trees, Object ProElemtree

Function ProElemtreeElementVisit

Description

Recursively visits the subelements of the specified element in the element tree. Note that the element must be an array, and the element path cannot contain an index to visit subelements for each index.

The visit function is called if the filter function is PRO_TK_NO_FUNCTION, or if it returns an error code other than PRO_TK_NO_ERROR.

Traversal continues until all the elements have been visited, or if the visit function returns an error code other than PRO_TK_NO_ERROR, or filter function returns an error code other than PRO_TK_NO_ERROR and PRO_TK_CONTINUE.

Synopsis

#include <ProElement.h>

ProError

ProElemtreeElementVisit

(

ProElement elemtree

/* (In)

The element tree

ProElempath elempath

/* (In)

The path to the element

ProElemtreeVisitFilter filterfunc

/* (In)

The filter function. If NULL, all elements are visited using the action function.

ProElemtreeVisitAction visitfunc

/* (In)

The visit function

ProAppData appdata

/* (In)

The user data passed to the visit and filter functions

)

Returns

PRO_TK_NO_ERROR		The function successfully visited all the subelements.
PRO_TK_BAD_INPUTS		One or more of the arguments are invalid.
PRO_TK_E_NOT_FOUND		Visit function was never called.
Other		Any other value is the error code returned by the visit or filter function (visiting stopped).