Error Handling

Error codes and descriptions. More...

Defines
#define	RAPP_ERR_BUF_NULL
	Pixel buffer pointer is NULL.
#define	RAPP_ERR_BUF_ALIGN
	Invalid pixel buffer alignment.
#define	RAPP_ERR_BUF_OFFSET
	Invalid pixel buffer bit offset.
#define	RAPP_ERR_DIM_ALIGN
	Invalid buffer dimension alignment.
#define	RAPP_ERR_IMG_SIZE
	Invalid image size.
#define	RAPP_ERR_PARM_NULL
	Parameter is NULL.
#define	RAPP_ERR_PARM_RANGE
	Parameter is out-of-range.
#define	RAPP_ERR_UNINITIALIZED
	Missing call to rapp_initialize().
#define	RAPP_ERR_OVERLAP
	Buffer parameters overlap.
Functions
const char *	rapp_error (int code)
	Get a description string for a given error code.

---

Detailed Description

Error codes and descriptions.

Errors are indicated by the return value of the function. Only argument errors are possible – functions have no internal failure modes (besides when RAPP is not initialized). A negative value indicate an error condition. In case of several errors after initialization, the first one in argument-order is returned. This number can be passed to the rapp_error() function to obtain a string describing the error condition.

Next section: Pixel Access

---

Define Documentation

#define RAPP_ERR_BUF_NULL

Pixel buffer pointer is NULL.

#define RAPP_ERR_BUF_ALIGN

Invalid pixel buffer alignment.

#define RAPP_ERR_BUF_OFFSET

Invalid pixel buffer bit offset.

#define RAPP_ERR_DIM_ALIGN

Invalid buffer dimension alignment.

#define RAPP_ERR_IMG_SIZE

Invalid image size.

#define RAPP_ERR_PARM_NULL

Parameter is NULL.

#define RAPP_ERR_PARM_RANGE

Parameter is out-of-range.

#define RAPP_ERR_UNINITIALIZED

Missing call to rapp_initialize().

#define RAPP_ERR_OVERLAP

Buffer parameters overlap.

---

Function Documentation

const char* rapp_error

(

int

code

)

Get a description string for a given error code.

Parameters:

code

A negative error code from a RAPP function.

Returns:

A C (NUL-terminated) string from constant memory describing the error condition. This function is valid to call also when RAPP is not initialized.