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

axis2_om_attribute_ops Struct Reference
[OM Attribute]

OM attribute operations struct operations Encapsulator struct for axis2_om_attribute. More...

#include <axis2_om_attribute.h>

List of all members.

Public Attributes

axis2_status_t(* free )(struct axis2_om_attribute *om_attribute, axis2_env_t **env)
axis2_qname_t *(* get_qname )(struct axis2_om_attribute *om_attribute, axis2_env_t **env)
int(* serialize )(struct axis2_om_attribute *om_attribute, axis2_env_t **env, axis2_om_output_t *om_output)
axis2_char_t *(* get_localname )(struct axis2_om_attribute *om_attribute, axis2_env_t **env)
axis2_char_t *(* get_value )(struct axis2_om_attribute *om_attribute, axis2_env_t **env)
axis2_om_namespace_t *(* get_namespace )(struct axis2_om_attribute *om_attribute, axis2_env_t **env)
axis2_status_t(* set_localname )(struct axis2_om_attribute *om_attribute, axis2_env_t **env, const axis2_char_t *localname)
axis2_status_t(* set_value )(struct axis2_om_attribute *om_attribute, axis2_env_t **env, const axis2_char_t *value)
axis2_status_t(* set_namespace )(struct axis2_om_attribute *om_attribute, axis2_env_t **env, axis2_om_namespace_t *om_namespace)


Detailed Description

OM attribute operations struct operations Encapsulator struct for axis2_om_attribute.


Member Data Documentation

axis2_status_t( * axis2_om_attribute_ops::free)(struct axis2_om_attribute *om_attribute, axis2_env_t **env)
 

Free an axis2_om_attribute struct

Parameters:
om_attribute pointer to attribute struct to be freed
env Environment. MUST NOT be NULL
Returns:
satus of the operation. AXIS2_SUCCESS on success else AXIS2_FAILURE

axis2_char_t*( * axis2_om_attribute_ops::get_localname)(struct axis2_om_attribute *om_attribute, axis2_env_t **env)
 

returns the localname of this attribute

Parameters:
om_attribute pointer to attribute struct
env environment. MUST NOT not be NULL.
Returns:
localname returns NULL on error.

axis2_om_namespace_t*( * axis2_om_attribute_ops::get_namespace)(struct axis2_om_attribute *om_attribute, axis2_env_t **env)
 

returns namespace of this attribute

Parameters:
om_attribute 
env environment MUST NOT be NULL
Returns:
a pointer to om_namespace struct , returns NULL on error.

axis2_qname_t*( * axis2_om_attribute_ops::get_qname)(struct axis2_om_attribute *om_attribute, axis2_env_t **env)
 

Creates and returns a qname struct for this attribute

Parameters:
om_attribute pointer to attribute struct for which the qname is to be returned
env Environment. MUST NOT be NULL
Returns:
returns qname for given attribute.NULL on error

axis2_char_t*( * axis2_om_attribute_ops::get_value)(struct axis2_om_attribute *om_attribute, axis2_env_t **env)
 

returns value of this attribute

Parameters:
om_attribute pointer to om_attribute struct
env environment N not be null
Returns:
value , null on error

int( * axis2_om_attribute_ops::serialize)(struct axis2_om_attribute *om_attribute, axis2_env_t **env, axis2_om_output_t *om_output)
 

Serialize operation

Parameters:
om_attribute pointer to attribute struct to be serialized
env Environment. MUST NOT be NULL,
om_output OM output handler to be used in serializing
Returns:
satus of the operation. AXIS2_SUCCESS on success else AXIS2_FAILURE.

axis2_status_t( * axis2_om_attribute_ops::set_localname)(struct axis2_om_attribute *om_attribute, axis2_env_t **env, const axis2_char_t *localname)
 

sets the localname of the attribute

Parameters:
om_attribute pointer to om attribute struct.
env environment, MUST NOT be null.
localname localname that should be set for this attribute
Returns:
status code AXIS2_SUCCESS on success and AXIS2_FAILURE on error.

axis2_status_t( * axis2_om_attribute_ops::set_namespace)(struct axis2_om_attribute *om_attribute, axis2_env_t **env, axis2_om_namespace_t *om_namespace)
 

set namespace of the attribute

Parameters:
om_attribute a pointer to om_attribute struct
env environment, MUST NOT be NULL.
om_namespace a pointer to om_namespace struct that should be set for this attribute
Returns:
status code, AXIS2_SUCCESS on success and AXIS2_FAILURE on error.

axis2_status_t( * axis2_om_attribute_ops::set_value)(struct axis2_om_attribute *om_attribute, axis2_env_t **env, const axis2_char_t *value)
 

set the attribute value

Parameters:
om_attribute a pointer to om_attribute struct.
env environment, MUST NOT be NULL.
value value that should be set for this attribute
Returns:
status code, 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:31 2005 for Axis2/C by  doxygen 1.4.2