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

axis2.h File Reference

Axis2c specific global declarations. More...

#include <stdlib.h>
#include <stdio.h>
#include <axis2_env.h>

Go to the source code of this file.

Defines

#define AXIS2_FUNC_PARAM_CHECK(object, env, error_return)
#define AXIS2_PARAM_CHECK(error, object, error_return)
#define AXIS2_ERROR_SET(error, error_number, error_return)
#define WSA_ACTION   "wsamapping"


Detailed Description

Axis2c specific global declarations.


Define Documentation

#define AXIS2_ERROR_SET error,
error_number,
error_return   ) 
 

Value:

{ \
        AXIS2_ERROR_SET_ERROR_NUMBER(error, error_number); \
        AXIS2_ERROR_SET_STATUS_CODE(error, AXIS2_FAILURE); \
        return error_return; \
    }
This macro is used to handle error situation.
Parameters:
error_number Error number for the error occured
error_return If function return a status it should pass here AXIS2_FAILURE. If function return a type pointer it should pass NULL
Returns:
If function return a status code return AXIS2_SUCCESS. Else if function return a type pointer return NULL

#define AXIS2_FUNC_PARAM_CHECK object,
env,
error_return   ) 
 

Value:

AXIS2_ENV_CHECK(env, error_return);\
    if (!object) \
    { \
        AXIS2_ERROR_SET_ERROR_NUMBER((*env)->error, AXIS2_ERROR_INVALID_NULL_PARAM); \
        AXIS2_ERROR_SET_STATUS_CODE((*env)->error, AXIS2_FAILURE); \
        return error_return; \
    } \
    else \
    { \
        AXIS2_ERROR_SET_STATUS_CODE((*env)->error, AXIS2_SUCCESS); \
    }
This macro is called to check whether structure on which function is called is NULL and to check whether the environment structure passed is valid.
Parameters:
object structure on which function is called
env environment to be checked for validity
error_return If function return a status it should pass here AXIS2_FAILURE. If function return a type pointer it should pass NULL
Returns:
If function return a status code return AXIS2_SUCCESS. Else if function return a type pointer return NULL

#define AXIS2_PARAM_CHECK error,
object,
error_return   ) 
 

Value:

if (!object) \
    { \
        AXIS2_ERROR_SET_ERROR_NUMBER(error, AXIS2_ERROR_INVALID_NULL_PARAM); \
        AXIS2_ERROR_SET_STATUS_CODE(error, AXIS2_FAILURE); \
        return error_return; \
    } \
    else \
    { \
        AXIS2_ERROR_SET_STATUS_CODE(error, AXIS2_SUCCESS); \
    }
This macro is called to check whether an object is NULL. if object is NULL error number and status code is set
Parameters:
object object to be check for NULL
error_return If function return a status it should pass here AXIS2_FAILURE. If function return a type pointer it should pass NULL
Returns:
If function return a status code return AXIS2_SUCCESS. Else if function return a type pointer return NULL


Generated on Wed Dec 7 07:58:25 2005 for Axis2/C by  doxygen 1.4.2