Error Codes

Macros
#define	E_NO_ERROR   0
#define	E_SUCCESS   0
#define	E_NULL_PTR   -1
#define	E_NO_DEVICE   -2
#define	E_BAD_PARAM   -3
#define	E_INVALID   -4
#define	E_UNINITIALIZED   -5
#define	E_BUSY   -6
#define	E_BAD_STATE   -7
#define	E_UNKNOWN   -8
#define	E_COMM_ERR   -9
#define	E_TIME_OUT   -10
#define	E_NO_RESPONSE   -11
#define	E_OVERFLOW   -12
#define	E_UNDERFLOW   -13
#define	E_NONE_AVAIL   -14
#define	E_SHUTDOWN   -15
#define	E_ABORT   -16
#define	E_NOT_SUPPORTED   -17
#define	E_FAIL   -255

Detailed Description

A list of common error codes used by the API.

Note

A Negative Error Convention is used to avoid conflict with positive, Non-Error, returns.

Macro Definition Documentation

E_ABORT

#define E_ABORT   -16

Event was aborted

E_BAD_PARAM

#define E_BAD_PARAM   -3

Parameter not acceptable

E_BAD_STATE

#define E_BAD_STATE   -7

Operation not allowed in current state

E_BUSY

#define E_BUSY   -6

Busy now, try again later

E_COMM_ERR

#define E_COMM_ERR   -9

General communications error

E_FAIL

#define E_FAIL   -255

The requested operation is failed

E_INVALID

#define E_INVALID   -4

Value not valid or allowed

E_NO_DEVICE

#define E_NO_DEVICE   -2

No such device

E_NO_ERROR

#define E_NO_ERROR   0

No Error

E_NO_RESPONSE

#define E_NO_RESPONSE   -11

Expected response did not occur

E_NONE_AVAIL

#define E_NONE_AVAIL   -14

Data or resource not available at this time

E_NOT_SUPPORTED

#define E_NOT_SUPPORTED   -17

The requested operation is not supported

E_NULL_PTR

#define E_NULL_PTR   -1

Pointer is NULL

E_OVERFLOW

#define E_OVERFLOW   -12

Operations resulted in unexpected overflow

E_SHUTDOWN

#define E_SHUTDOWN   -15

Event was shutdown

E_SUCCESS

#define E_SUCCESS   0

No Error, success

E_TIME_OUT

#define E_TIME_OUT   -10

Operation timed out

E_UNDERFLOW

#define E_UNDERFLOW   -13

Operations resulted in unexpected underflow

E_UNINITIALIZED

#define E_UNINITIALIZED   -5

Module not initialized

E_UNKNOWN

#define E_UNKNOWN   -8

Generic error