Error Codes

Error codes used by the xrif library. More...

Error codes used by the xrif library.

This library defines an error code type (merely an int) and a number of codes, all less than zero, to report errors. In general we avoid in-band error reporting, with a few exceptions (e.g. xrif_typesize).

Macros
#define	XRIF_NOERROR   (0)
	Return code for success.
#define	XRIF_ERROR_NULLPTR   (-5)
	Return code indicating that a NULL pointer was passed.
#define	XRIF_ERROR_NOT_SETUP   (-10)
	Return code indicating that the handle was not setup.
#define	XRIF_ERROR_INVALID_SIZE   (-20)
	Return code indicating that an invalid size was passed.
#define	XRIF_ERROR_INVALID_TYPE   (-22)
	Return code indicating that an invalid type was passed.
#define	XRIF_ERROR_INSUFFICIENT_SIZE   (-25)
	Return code indicating that an insufficient size was given.
#define	XRIF_ERROR_MALLOC   (-30)
	Return code indicating a malloc failure.
#define	XRIF_ERROR_NOTIMPL   (-100)
	Return code indicating that the requested feature is not available.
#define	XRIF_ERROR_BADARG   (-110)
	Return code indicating that a bad argument was passed.
#define	XRIF_ERROR_BADHEADER   (-1000)
	Return code indicating that the header is bad.
#define	XRIF_ERROR_WRONGVERSION   (-1010)
	Return code indicating that a wrong version was specified.
#define	XRIF_ERROR_LIBERR   (-10000)
	Return code indicating a library returned an error (e.g. LZ4). The library error code may be added to this.
#define	XRIF_ERROR_PRINT(function, msg)   fprintf(stderr, "%s: %s\n", function, msg)
	Standard error report.

Typedefs
typedef int	xrif_error_t
	The error reporting type.