Api functions – MagTek Excella Windows API99875313 User Manual

Page 19

Advertising
background image

Section 2. Excella Architecture and Operation


11

API FUNCTIONS

Table 2-1 lists functions provided by mtmcrapi.dll. Please refer to Section 3 for a complete
description of these functions.

Table 2-1. Functions

NAME

DESCRIPTION

PAGE

MTMICRGetDevice

Returns the device name of the device present in
the system.

15

MTMICROpenDevice

Opens the device with the given device name.

16

MTMICRCloseDevice

Closes the device with the given device name.

17

MTMICRSetValue

Adds a key/value pair to a given section.

18

MTMICRSetIndexValue

Adds a key/value pair with index to a given section.

20

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.

26

MTMICRProcessCheck

Sends a scan request to a given device to scan with
a given process options.

27

MTMICRGetImage

Sends request to the given device name to get an
image of a previously scanned check.

28

MTMICRGetImages

Sends request to the given device name to get one
or more images of a previously scanned check.

30

MTMICRGetSectionCount

Returns the number of sections present in a given
document information.

32

MTMICRSectionName

Returns the section name of the given section
number in a given document information.

32

MTMICRGetKeyCount

Returns the number of keys present in a given
section in a given document information.

36

MTMICRKeyName

Returns the key name of the given key number in a
given document information.

38

MTMICRSetTimeout

Sets device communication timeout in milliseconds.

41

MTMICRGetTimeout

Gets device communication timeout in milliseconds.

42

MTMICRSetLogFile

Logs all errors in the given file name.

43

MTMICRSetLogFileHandle

Logs all errors in the given file handle.

44

Advertising