KIM Error Reference Documentation

Functions

Function Documentation

kim_error_t kim_error_copy (  kim_error_t *  out_error,
kim_error_t  in_error
) 
 

Copy an error.

Parameters:
out_error on exit, a new error object which is a copy of in_error. Must be freed with kim_error_free().
in_error the error to copy.
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.

kim_error_code_t kim_error_get_code (  kim_error_t  in_error  ) 
 

Get a numerical error code for an error.

Parameters:
in_error an error object.
Returns:
On success, a machine-readable error code describing the error represented by in_error. On failure, KIM_PARAMETER_ECODE.

const kim_string_t kim_error_get_display_string (  kim_error_t  in_error  ) 
 

Get a text description of an error.

Parameters:
in_error an error object.
Returns:
On success, a human-readable error string describing the error represented by in_error. On failure, NULL, indicating that the kim_error_t object was invalid.

void kim_error_free (  kim_error_t *  io_error  ) 
 

Free memory associated with an error.

Parameters:
io_error the error object to be freed. Set to NULL on exit.