Error handling functions. More...

Typedefs
typedef struct DIFFUSION_API_ERROR_T *	DIFFUSION_API_ERROR
	Opaque diffusion API error data type.

Functions
int	get_diffusion_api_error_code (DIFFUSION_API_ERROR error)
	Return the error's code. More...

const char *	get_diffusion_api_error_description (DIFFUSION_API_ERROR error)
	Returns the API error description. More...

void	diffusion_api_error_free (DIFFUSION_API_ERROR error)
	Free a diffusion API error. More...

Detailed Description

Error handling functions.

Function Documentation

void diffusion_api_error_free ( DIFFUSION_API_ERROR error )

Free a diffusion API error.

Parameters

error error to be freed.

int get_diffusion_api_error_code ( DIFFUSION_API_ERROR error )

Return the error's code.

Parameters

error the API error

Returns: the error code. If 0 is returned, the provided error value does not contain an error.

const char* get_diffusion_api_error_description ( DIFFUSION_API_ERROR error )

Returns the API error description.

Parameters

error the API error

Returns: the description. Will return NULL if the provided error value does not contain an error.