Classes | |
struct | axutil_error |
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 |
Functions | |
AXIS2_EXTERN const axis2_char_t * | axutil_error_get_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 void | axutil_error_free (struct axutil_error *error) |
AXIS2_EXTERN axutil_error_t * | axutil_error_create (axutil_allocator_t *allocator) |
#define AXIS2_ERROR_FREE | ( | error | ) | axutil_error_free(error) |
typedef struct axutil_error axutil_error_t |
Axutil error struct. Error holds the last error number, the status code as well as the last error message.
AXIS2_EXTERN axutil_error_t* axutil_error_create | ( | axutil_allocator_t * | allocator | ) |
Creates an error struct
allocator | allocator to be used. Mandatory, cannot be NULL |
AXIS2_EXTERN void axutil_error_free | ( | struct axutil_error * | error | ) |
De-allocates an error struct instance.
error | pointer to error struct instance to be freed. |
AXIS2_EXTERN const axis2_char_t* axutil_error_get_message | ( | const struct axutil_error * | error | ) |
Gets the error message corresponding to the last error occurred.
error | pointer to error struct |
AXIS2_EXTERN axis2_status_t axutil_error_get_status_code | ( | struct axutil_error * | error | ) |
Gets the status code.
error | pointer to error struct |
AXIS2_EXTERN axis2_status_t axutil_error_init | ( | ) |
Initializes the axutil_error_messages array. This array holds the error messages that corresponds to the error codes. This function must be call before using the error struct instance.
AXIS2_EXTERN axis2_status_t axutil_error_set_error_message | ( | struct axutil_error * | error, | |
axis2_char_t * | message | |||
) |
Sets error message to the given value.
error | pointer to error struct | |
message | error message to be set |
AXIS2_EXTERN axis2_status_t axutil_error_set_error_number | ( | struct axutil_error * | error, | |
axutil_error_codes_t | error_number | |||
) |
Sets the error number.
error | pointer to error struct | |
error_number | error number to be set |
AXIS2_EXTERN axis2_status_t axutil_error_set_status_code | ( | struct axutil_error * | error, | |
axis2_status_codes_t | status_code | |||
) |
Sets the status code.
error | pointer to error struct | |
status_code | status code to be set |