axiom_children_iterator_ops Struct Reference
[children iterator]

axiom_children_iterator ops Encapsulator struct for ops of axiom_iterator More...

#include <axiom_children_iterator.h>

List of all members.

Public Attributes

axis2_status_t(* free_fn )(axiom_children_iterator_t *iterator, const axis2_env_t *env)
axis2_status_t(* remove )(axiom_children_iterator_t *iterator, const axis2_env_t *env)
axis2_bool_t(* has_next )(axiom_children_iterator_t *iterator, const axis2_env_t *env)
axiom_node_t *(* next )(axiom_children_iterator_t *iterator, const axis2_env_t *env)
axis2_status_t(* reset )(axiom_children_iterator_t *iterator, const axis2_env_t *env)


Detailed Description

axiom_children_iterator ops Encapsulator struct for ops of axiom_iterator


Member Data Documentation

axis2_status_t( * axiom_children_iterator_ops::free_fn)(axiom_children_iterator_t *iterator, const axis2_env_t *env)

Free the om_children_iterator struct

axis2_bool_t( * axiom_children_iterator_ops::has_next)(axiom_children_iterator_t *iterator, const axis2_env_t *env)

Returns:
true if the iteration has more elements. In other words, returns true if next() would return an om_node_t struct rather than null with error code set in environment

axiom_node_t*( * axiom_children_iterator_ops::next)(axiom_children_iterator_t *iterator, const axis2_env_t *env)

Returns the next element in the iteration. Returns null if there are no more elements in the iteration

axis2_status_t( * axiom_children_iterator_ops::remove)(axiom_children_iterator_t *iterator, const axis2_env_t *env)

Removes from the underlying collection the last element returned by the iterator (optional op). This method can be called only once per call to next. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method.

axis2_status_t( * axiom_children_iterator_ops::reset)(axiom_children_iterator_t *iterator, const axis2_env_t *env)

Resets the Iterator. This moves the cursor back to the initial. iterator chidren_iterator to be reset.

Parameters:
env Environment. MUST NOT be NULL.
Returns:
satus of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE.


The documentation for this struct was generated from the following file:
Generated on Thu Oct 26 21:00:30 2006 for Axis2/C by  doxygen 1.4.7