MagTek Excella STX99875340 - Manual (Page 21)

Section 2. Excella Software Architecture
11
API FUNCTIONS
Table 2-1 lists functions provided by MTXMLMCR.dll. Please refer to Section 3 for a complete
description of these functions.
Table 2-1. Functions
NAME DESCRIPTION PAGE
MTMICRGetDevice Get device name of all devices present. 15
MTMICROpenDevice Opens device with the given name. 16
MTMICRCloseDevice Closes device with the given name. 17
MTMICRDeviceConnect Connects device with IP or DNS name. 18
MTMICRDeviceDisconnect Disconnect device with the given IP or DNS name. 19
MTMICRSetValue Adds a key/value pair to a given section. 20
MTMICRSetIndexValue Adds a key/value pair with index to a given section. 21
MTMICRGetValue Returns value of a key/value pair from a given section. 22
MTMICRGetIndexValue
Returns value of a key/value pair with index from a given
section.
24
MTMICRQueryInfo
Sends a request to a given device name to query for info
on a given query parameter.
25
MTMICRSendCommand Sends a single command to a given device name. 27
MTMICRProcessCheck
Sends a scan request to a given device to scan with a
given process options.
28
MTMICRGetImage
Sends request to the given device name to get an image
of a previously scanned check.
30
MTMICRGetImages
Sends request to the given device name to get one or
more images of a previously scanned check.
32
MTMICRGetSectionCount
Returns the number of sections present in a given
document information.
34
MTMICRGetSectionName
Returns the section name of the given section number in
a given document information.
36
MTMICRGetKeyCount
Returns the number of keys present in a given section in
a given document information.
37
MTMICRGetKeyName
Returns the key name of the given key number in a given
document information.
40
MTMICRSetTimeout Sets device communication timeout in milliseconds. 48
MTMICRGetTimeout Gets device communication timeout in milliseconds. 49
MTMICRLogEnable Enable the logging. 50
MTMICRSetLogFileHandle Logs errors to the given file handle. 51
MTMICRSetLogLevel Sets the level of details for logging 52
MTMICRCOMInitialize Enable MSXML instantiation at DLL level 53
MTMICRCOMUnInitialize Disable MSXML instantiation at DLL level 54
MTMICRSetConfigFile
Set the path and file name of the config file. Default is
"MICRDEV.INI"
55