error_types.h File Reference

Types and structures relating to reported errors. More...

Data Structures
struct	diffusion_error_s
	A structure which is filled by the API when an error occurs. More...

Typedefs
typedef struct diffusion_error_s	DIFFUSION_ERROR_T
	A structure which is filled by the API when an error occurs.

Enumerations
enum	ERROR_CODE_T
	Errors which can be raised by API functions.

Functions
DIFFUSION_ERROR_T *	diffusion_error_dup (const DIFFUSION_ERROR_T *error)
	Create a duplicate of the error.
void	diffusion_error_free (DIFFUSION_ERROR_T *error)
	Free a memory allocated DIFFUSION_ERROR_T.

Detailed Description

Types and structures relating to reported errors.

Copyright © 2014 - 2023 DiffusionData Ltd., All Rights Reserved.

Use is subject to licence terms.

NOTICE: All information contained herein is, and remains the property of DiffusionData. The intellectual and technical concepts contained herein are proprietary to DiffusionData and may be covered by U.S. and Foreign Patents, patents in process, and are protected by trade secret or copyright law.

Function Documentation

diffusion_error_dup()

DIFFUSION_ERROR_T * diffusion_error_dup

(

const DIFFUSION_ERROR_T *

error

)

Create a duplicate of the error.

To free the created error, use diffusion_error_free.

Parameters

error

the error to be duplicated

Returns

the duplicated error.

diffusion_error_free()

void diffusion_error_free

(

DIFFUSION_ERROR_T *

error

)

Free a memory allocated DIFFUSION_ERROR_T.

Parameters

error

to be freed.