axl main logo
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Modules Pages
axl_bool axl_doc_iterate_full ( axlDoc doc,
AxlIterationMode  mode,
axlIterationFunc2  func,
axlPointer  ptr,
axlPointer  ptr2 
)

Allows to perform an iteration over the documented provided, visiting all nodes inside it (with two user defined pointers support).

The function allows to configure the iteration module using AxlIterationMode (mode variable) and providing a callback function that will be called for each node found (axlIterationFunc).

The function, optionall, allows to provide two user pointer that will be passed to the callback function. See documentation for the callback and the iteration module for more details. See also axl_doc_iterate.

Parameters
docThe xml document that will be iterated.
modeThe iterarion type to be performed.
funcThe function to be called for each node found.
ptrAn user defined pointer that will be passed to the callback function.
ptr2Second user defined pointer that will be passed to the callback function.
Returns
The function returns axl_true if the iteration was performed over all nodes or axl_false it it was stoped by the iteration function (by returning axl_false to stop the iteration). The function also axl_false if the parameters provided doc or func are not defined.

References axl_doc_get_root(), axl_false, and axl_return_val_if_fail.