MagTek Excella STX99875340 - Manual (Page 39)

Section 3. Excella API
29
Return Values
MICR_ST_OK
MICR_ST_NOT_ENOUGH_MEMORY
MICR_ST_PROCESS_CHECK_FAILED
MICR_ST_BAD_DATA
MICR_ST_BAD_BUFFER
MICR_ST_BAD_BUFFER_LENGTH
MICR_ST_BAD_DEVICE_NAME
MICR_ST_DEVICE_NOT_OPEN
MICR_ST_DEVICE_NOT_RESPONDING
MICR_ST_REQUEST_TIMEDOUT
MICR_ST_CONNECT_REQUEST_TIMEDOUT
MICR_ST_ERR_INTERNET_CONNECT
MICR_ST_ERR_HTTP_OPEN_REQUEST
MICR_ST_ERR_HTTP_SEND_REQUEST
MICR_ST_INET_GET_DATA_FAILED
MICR_ST_USB_GET_DATA_FAILED
MICR_ST_HTTP_HEADER_NOT_FOUND
Remarks
If the function succeeds MICR_ST_OK is returned.
If there is no data returns from device, error MICR_ST_PROCESS_CHECK_FAILED is returned
If
pcProcessOptions is NULL, error MICR_ST_BAD_DATA is returned
If pcDocInfo is NULL, error MICR_ST_BAD_BUFFER is returned
If the size of returned data is larger than the value specified in pdwDocInfoSize, error
MICR_ST_NOT_ENOUGH_MEMORY is returned
If the function fails to get HTTP header information, MICR_ST_HTTP_HEADER_NOT_FOUND is returned.
Error results from bad connection with device can be one of the following:
MICR_ST_CONNECT_REQUEST_TIMEDOUT
MICR_ST_REQUEST_TIMEDOUT
MICR_ST_DEVICE_NOT_RESPONDING
MICR_ST_ERR_INTERNET_CONNECT
MICR_ST_ERR_HTTP_OPEN_REQUEST
MICR_ST_ERR_HTTP_SEND_REQUEST
MICR_ST_USB_GET_DATA_FAILED
MICR_ST_INET_GET_DATA_FAILED
Example
#define BUFFER_LEN 4096
char docInfo [BUFFER_LEN];
char options [BUFFER_LEN];
char Device[4096] ="";
DWORD docInfoSize;;
// Set up options using function MTMICRSetValue or function MTMICRSetIndexValue
// Use function MTMICRGetDevice to get device name for variable “Device”
docInfoSize = BUFFER_LEN;
dwStatus=MTMICRProcessCheck(Device, options, docInfo, &docInfoSize);
// Use MTMICRGetValue and MTMICRGetIndexValue to parse the docInfo.