Error Handling

Auxiliary functions for handling & reporting errors.

Enumerations

enum  {
  DCERR_COMM_GENERIC = -256, DCERR_COMM_INIT, DCERR_COMM_NAK, DCERR_COMM_RET,
  DCERR_COMM_CRC, DCERR_COMM_BUSY, DCERR_COMM_TIMEOUT, DCERR_COMM_FRAME,
  DCERR_COMM_OVERRRUN, DCERR_COMM_ONBOARD, DCERR_COMM_DISCONNECT, DCERR_MODULE_LOAD = -128,
  DCERR_MODULE_SYMBOL, DCERR_MALLOC, DCERR_BADPTR, DCERR_CANCEL,
  DCERR_MUTEX, DCERR_PROPERTY_UNKNOWN = -64, DCERR_PROPERTY_ACCESS, DCERR_PROPERTY_TYPE_MATCH,
  DCERR_PROPERTY_SIZE_MATCH, DCERR_PROPERTY_TYPE_UNKNOWN, DCERR_PROPERTY_HANDLER, DCERR_PROPERTY_RANGE,
  DCERR_PROPERTY_OPERATION, DCERR_MODEL_UNSUPPORTED = -16, DCERR_REVISION_UNSUPPORTED, DCWARN_HEADER_INVALID = 4,
  DCWARN_REVISION_NEWER, DCWARN_PROPERTY_MODIFIED, DCWARN_PROPERTY_INACTIVE, DCWARN_PROPERTY_RESETALL = 32,
  DCWARN_CMD_UNSUPPORTED = 64, DCWARN_PROPERTY_NIL = 128
}

Functions

const char *APIDECL dcGetErrorString (int error)
 Verbose error string query of an error code.

Enumeration Type Documentation

anonymous enum
Enumerator:
DCERR_COMM_GENERIC 

Generic communication failure.

DCERR_COMM_INIT 

Communication port initialization failed.

DCERR_COMM_NAK 

Command not acknowledged.

Possible communication failure.

DCERR_COMM_RET 

Bad return code.

Possible communication failure.

DCERR_COMM_CRC 

CRC error.

DCERR_COMM_BUSY 

Communication timeout.

DCERR_COMM_TIMEOUT 

Communication timeout.

DCERR_COMM_FRAME 

Communication frame error (Parity, word length, .

..)

DCERR_COMM_OVERRRUN 

Communication buffer overrun.

DCERR_COMM_ONBOARD 

Onboard communication failure.

DCERR_COMM_DISCONNECT 

Peer has disconnected.

DCERR_MODULE_LOAD 

Module loader: could not load DLL.

DCERR_MODULE_SYMBOL 

Module loader: could not find symbol in DLL.

DCERR_MALLOC 

Could not reserve memory.

DCERR_BADPTR 

Bad device handle or pointer value (Null pointer?).

DCERR_CANCEL 

Operation was cancelled by user.

DCERR_MUTEX 

Mutex error (Initialization, Locking, .

..)

DCERR_PROPERTY_UNKNOWN 

Unknown device property.

DCERR_PROPERTY_ACCESS 

Property access error, Property is read- or write only.

DCERR_PROPERTY_TYPE_MATCH 

Property type mismatch.

DCERR_PROPERTY_SIZE_MATCH 

Property size mismatch (buffer or register size).

DCERR_PROPERTY_TYPE_UNKNOWN 

Unknown property type.

DCERR_PROPERTY_HANDLER 

Property Handler missing.

DCERR_PROPERTY_RANGE 

Invalid value range.

DCERR_PROPERTY_OPERATION 

This operation is not supported on the specified Property.

DCERR_MODEL_UNSUPPORTED 

This device model is unsupported or can not be autoprobed.

Please use the software that came with the device.

DCERR_REVISION_UNSUPPORTED 

This revision is not supported, please update your software.

DCWARN_HEADER_INVALID 

The device header is corrupted (request header update).

DCWARN_REVISION_NEWER 

The firmware revision is newer than the one supported by this driver.

Please update your software.

DCWARN_PROPERTY_MODIFIED 

Setting of this property affected another property.

DCWARN_PROPERTY_INACTIVE 

Property is inactive, value setting causes no effect.

DCWARN_PROPERTY_RESETALL 

All properties were reset - reread needed.

DCWARN_CMD_UNSUPPORTED 

Unsupported command.

DCWARN_PROPERTY_NIL 

Last property in list reached.


Function Documentation

const char* APIDECL dcGetErrorString ( int  error  ) 
Parameters:
error The error code returned by a function.
Returns:
Pointer to a constant string containing the error message to the specified error code.
Examples:
master.c.

Generated on Thu Feb 24 13:50:16 2011 for Device Control library by  doxygen 1.6.1