Parameter Container


Files

file  axis2_param_container.h
 Axis2 Param container interface.

Classes

struct  axis2_param_container_ops
 Param Container ops struct Encapsulator struct for ops of axis2_param_container. More...
struct  axis2_param_container
 Param container struct Container for params. More...

Defines

#define AXIS2_PARAM_CONTAINER_FREE(param_container, env)   ((param_container)->ops->free (param_container, env))
#define AXIS2_PARAM_CONTAINER_ADD_PARAM(param_container, env, param)   ((param_container)->ops->add_param (param_container, env, param))
#define AXIS2_PARAM_CONTAINER_GET_PARAM(param_container, env, name)   ((param_container)->ops->get_param (param_container, env, name))
#define AXIS2_PARAM_CONTAINER_GET_PARAMS(param_container, env)   ((param_container)->ops->get_params (param_container, env))
#define AXIS2_PARAM_CONTAINER_IS_PARAM_LOCKED(param_container, env, param_name)

Typedefs

typedef axis2_status_t(* AXIS2_PARAM_VALUE_FREE )(void *param, const axis2_env_t *env)
typedef axis2_param_container_ops axis2_param_container_ops_t
 Param Container ops struct Encapsulator struct for ops of axis2_param_container.
typedef axis2_param_container axis2_param_container_t
 Param container struct Container for params.

Functions

AXIS2_EXTERN axis2_param_container_taxis2_param_container_create (const axis2_env_t *env)
AXIS2_EXTERN axis2_status_t axis2_param_container_free_void_arg (void *param_container, const axis2_env_t *env)

Define Documentation

#define AXIS2_PARAM_CONTAINER_IS_PARAM_LOCKED param_container,
env,
param_name   ) 
 

Value:

((param_container)->ops->is_param_locked (param_container, env, \
      param_name))


Typedef Documentation

typedef axis2_status_t( * AXIS2_PARAM_VALUE_FREE)(void *param, const axis2_env_t *env)
 

each type which is passed as a param value to a parameter, must have this type of function implemented. When the param value is set this function should also be assigned to param free function


Function Documentation

AXIS2_EXTERN axis2_param_container_t* axis2_param_container_create const axis2_env_t env  ) 
 

Creates param container struct

Returns:
pointer to newly created param container

AXIS2_EXTERN axis2_status_t axis2_param_container_free_void_arg void *  param_container,
const axis2_env_t env
 

Free param_container passed as void pointer. This will be cast into appropriate type and then pass the cast object into the param_container structure's free method


Generated on Thu Aug 31 17:32:42 2006 for Axis2/C by  doxygen 1.4.6