How to get check images, Process options, Error reporting – MagTek Excella STX99875340 User Manual
Page 24: Debugging api
Excella Windows API Specifications
14
HOW TO GET CHECK IMAGES
To get a check image, follow these steps:
1. The function
MTMICRProcessCheck
contains information of the process operation
provided by Excella device after it completes document processing. Use this information
to find the information of the scanned images in the ImageInfo section. The ImageInfo
section contains the size of the image and the image identification for each image.
2. Use function
MTMICRGetValue
or function
MTMICRGetIndexValue
to retrieve the size
and the URL of each image. Allocate memory for each image according to its given size.
3. Use function
MTMICRGetImage
to get one image at a time or function
MTMICRGetImages
to get all images at once. The image data is transferred to the buffer
that has memory allocated.
PROCESS OPTIONS
Process options are stored as key/value pairs in a buffer. The structure of the options follows
XML format. Use function
MTMICRSetValue
or function
MTMICRSetIndexValue
to add an
option to this structure. Options are string-based key/value pairs. Each option is stored only
once in the buffer. Function
MTMICRGetValue
and function
MTMICRGetIndexValue
can be used
to retrieve a key/value pair from this buffer.
ERROR REPORTING
When a document is processed, if there is an error in the Excella device or in the processing
operation, the error is returned in the function
MTMICRProcessCheck
. Use function
MTMICRGetValue
or function
MTMICRGetIndexValue
to retrieve the error information. Table 4-
13 to table 4-20 list return codes and return messages from Excella.
If an error occurs due to the failure of API function, the error is returned as the return code of the
API provided by MTXMLMCR.dll. Appendix B contains a list of errors returning from
MTXMLMCR.dll
DEBUGGING API
On the Excella Demo GUI program, there is an option to enable the error logging function. If
this option is enabled, all errors returned from the device are logged into log file named
“STXDemo.log”. This file resides in the Excella Demo program installation directory.