diffusion-api-error.h File Reference

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.
const char *	get_diffusion_api_error_description (DIFFUSION_API_ERROR error)
	Returns the API error description.
void	diffusion_api_error_free (DIFFUSION_API_ERROR error)
	Free a diffusion API error.

Detailed Description

Error handling functions.

Function Documentation

diffusion_api_error_free()

void diffusion_api_error_free

(

DIFFUSION_API_ERROR

error

)

Free a diffusion API error.

Parameters

error

error to be freed.

get_diffusion_api_error_code()

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.

get_diffusion_api_error_description()

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.