Owner manual

MagTek Communications Protocol, Driver Reference Manual
70
CONSTANT DEFINITIONS
Operation Attributes
#define MCP_ATTR_NONE 0 // No attributes specified
#define MCP_ATTR_WAIT_NEW 1 // Discard any notifications that may
// have been queued before returning
// a response.
#define MCP_ATTR_PROP_DRIVER 2 // MCP Driver specific property
Property Types
#define MCP_TYPE_NONE 0 // No type.
#define MCP_TYPE_DWORD 1 // 32-bit unsigned integer
#define MCP_TYPE_STRING 2 // Null terminated string of 8-bit
// ANSI characters.
#define MCP_TYPE_BOOLEAN 3 // Boolean value (True=1 or False=0)
#define MCP_TYPE_BINARY 4 // Binary data
Function Return Values
#define MCP_ST_OK 0 // successful operation
// resource manipulation
#define MCP_ST_ALLOC 20 // can't alloc (for variable size alloc/pool)
#define MCP_ST_NO_ROOM 21 // can't alloc fixed sz entry in fixed sz pool
#define MCP_ST_OVERFLOW 22 // value, buffer, whatever may overflow
#define MCP_ST_UNDERFLOW 23 // value, buffer, counter, whatever may
// underflow
#define MCP_ST_EMPTY 24 // queue/smth is empty - no elements
#define MCP_ST_FULL 25 // queue/smth is full
#define MCP_ST_EOF 26 // end of file
// valchk
#define MCP_ST_INVALID 30 // value not valid in operation context
#define MCP_ST_BAD_VALUE 31 // value not valid in module's context
#define MCP_ST_OUT_OF_RANGE 32 // value out of range
#define MCP_ST_NULL_PTR 33 // NULL ptr is not valid in operation context
#define MCP_ST_BAD_SYNTAX 34 // text/formatted data syntax error
#define MCP_ST_BAD_NAME 35 // name invalid in module's context
// severe errors
#define MCP_ST_UNEXPECTED 40 // unexpected condition of parameter or
// external object