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:
-
| doc | The xml document that will be iterated. |
| mode | The iterarion type to be performed. |
| func | The function to be called for each node found. |
| ptr | An user defined pointer that will be passed to the callback function. |
| ptr2 | Second user defined pointer that will be passed to the callback function. |
- Returns:
- The function returns true if the iteration was performed over all nodes or false it it was stoped by the iteration function (by returning false to stop the iteration). The function also false if the parameters provided doc or func are not defined.