Main Page | Modules | Class List | Directories | File List | Class Members | File Members

axis2_om_stax_builder_ops Struct Reference
[OM Stax Builder]

OM stax builder operations struct Encapsulator struct for operations of axis2_om_stax_builder. More...

#include <axis2_om_stax_builder.h>

List of all members.

Public Attributes

axis2_om_node_t *(* next )(struct axis2_om_stax_builder *builder, axis2_env_t **env)
axis2_status_t(* discard_current_element )(struct axis2_om_stax_builder *builder, axis2_env_t **env)
axis2_status_t(* free )(struct axis2_om_stax_builder *builder, axis2_env_t **env)
axis2_om_document_t *(* get_document )(struct axis2_om_stax_builder *builder, axis2_env_t **env)
axis2_status_t(* set_document )(struct axis2_om_stax_builder *builder, axis2_env_t **env, axis2_om_document_t *document)


Detailed Description

OM stax builder operations struct Encapsulator struct for operations of axis2_om_stax_builder.


Member Data Documentation

axis2_status_t( * axis2_om_stax_builder_ops::discard_current_element)(struct axis2_om_stax_builder *builder, axis2_env_t **env)
 

Discards the element that is being built currently.

Parameters:
environment Environment. MUST NOT be NULL, .
builder pointer to stax builder struct to be used
Returns:
satus of the operation. AXIS2_SUCCESS on success else AXIS2_FAILURE.

axis2_status_t( * axis2_om_stax_builder_ops::free)(struct axis2_om_stax_builder *builder, axis2_env_t **env)
 

Free operation

Parameters:
builder pointer to builder struct
env environment, MUST NOT be NULL
Returns:
status of the operation AXIS2_SUCCESS on success, AXIS2_FAILURE on error.

axis2_om_document_t*( * axis2_om_stax_builder_ops::get_document)(struct axis2_om_stax_builder *builder, axis2_env_t **env)
 

get the document associated with the builder

Parameters:
builder axis2_om_stax_builder
env environment
Returns:
pointer to document struct associated with builder NULL if there is no document associated with the builder, NULL if an error occured.

axis2_om_node_t*( * axis2_om_stax_builder_ops::next)(struct axis2_om_stax_builder *builder, axis2_env_t **env)
 

Builds the next node from stream. Moves pull parser forward and reacts to events.

Parameters:
environment Environment. MUST NOT be NULL.
builder pointer to stax builder struct to be used
Returns:
a pointer to the next node, or NULL if there are no more nodes. On erros sets the error and returns NULL.

axis2_status_t( * axis2_om_stax_builder_ops::set_document)(struct axis2_om_stax_builder *builder, axis2_env_t **env, axis2_om_document_t *document)
 

set the document associated with the builder

Parameters:
builder pointer to builder struct
env environment , MUST NOT be NULL.
document pointer to document struct that needs to be associated with builder
Returns:
status of the operation. AXIS2_SUCCESS on success and AXIS2_FAILURE on error.


The documentation for this struct was generated from the following file:
Generated on Thu Nov 24 13:58:32 2005 for Axis2/C by  doxygen 1.4.2