error
[utilities]


Classes

struct  axutil_error
 Axis2 Error struct. More...

Defines

#define AXIS2_ERROR_FREE(error)   axutil_error_free(error)
#define AXIS2_ERROR_GET_MESSAGE(error)   axutil_error_get_message(error)
#define AXIS2_ERROR_SET_MESSAGE(error, message)   axutil_error_set_error_message(error, message)
#define AXIS2_ERROR_SET_ERROR_NUMBER(error, error_number)   axutil_error_set_error_number(error, error_number)
#define AXIS2_ERROR_SET_STATUS_CODE(error, status_code)   axutil_error_set_status_code(error, status_code)
#define AXIS2_ERROR_GET_STATUS_CODE(error)   axutil_error_get_status_code(error)

Typedefs

typedef axutil_error axutil_error_t
 Axis2 Error struct.

Functions

AXIS2_EXTERN void axutil_error_free (struct axutil_error *error)
AXIS2_EXTERN const axis2_char_t * axutil_error_get_message (const struct axutil_error *error)
AXIS2_EXTERN const axis2_char_t * axutil_error_get_extended_message (const struct axutil_error *error)
AXIS2_EXTERN axis2_status_t axutil_error_set_error_number (struct axutil_error *error, axutil_error_codes_t error_number)
AXIS2_EXTERN axis2_status_t axutil_error_set_status_code (struct axutil_error *error, axis2_status_codes_t status_code)
AXIS2_EXTERN axis2_status_t axutil_error_get_status_code (struct axutil_error *error)
AXIS2_EXTERN axis2_status_t axutil_error_set_error_message (struct axutil_error *error, axis2_char_t *message)
AXIS2_EXTERN axis2_status_t axutil_error_init ()
AXIS2_EXTERN axutil_error_taxutil_error_create (axutil_allocator_t *allocator)

Typedef Documentation

typedef struct axutil_error axutil_error_t
 

Axis2 Error struct.

Error holds the last errorno


Function Documentation

AXIS2_EXTERN axutil_error_t* axutil_error_create axutil_allocator_t allocator  ) 
 

Creates an error struct

Parameters:
allocator allocator to be used. Mandatory, cannot be NULL
Returns:
pointer to the newly created error struct

AXIS2_EXTERN void axutil_error_free struct axutil_error error  ) 
 

deallocate memory of a error struct

Returns:
axis2_status_t status code

AXIS2_EXTERN const axis2_char_t* axutil_error_get_extended_message const struct axutil_error error  ) 
 

This fucntion is supposed to be overridden in an extended error structure. For example in Sandesha error structure this fucntion is overridden so that errors of axis2 range call the get_message function of error struct but errors of sandesha2 range get the messages from an array of that struct.

Returns:
error message for the extended struct.

AXIS2_EXTERN const axis2_char_t* axutil_error_get_message const struct axutil_error error  ) 
 

get error message for the last error

Returns:
error message for the last error. NULL on error.


Generated on Thu May 3 12:31:03 2007 for Axis2/C by  doxygen 1.4.6