Mtmicrsendcommand, Parameters, Return values – MagTek Excella STX99875340 User Manual

Page 37: Remarks

Advertising
background image

Section 3. Excella API

27

MTMICRSendCommand

MTMICRSendCommand function is used to send a single command to the device.

ULONG MTMICRSendCommand (

char

*pcDevName,

char

*pcCommand,

char

*pcResult,

DWORD

*pdwLength

);

Parameters


pcDevName

Pointer to null terminated string containing device name

.

pcCommand

Pointer to null terminated string containing the command string. There are two commands available: command
“ClearPathExit” and command “ClearPathEntry.”

pcResult

Pointer to the buffer that is used to store results returning from device.

pdwLength

Specifies the size of the pcResult buffer.

Return Values


MICR_ST_OK
MICR_ST_DEVICE_NOT_OPEN
MICR_ST_DEVICE_NOT_RESPONDING
MICR_ST_DEVICE_CONNECTION_ERROR
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_NOT_ENOUGH_MEMORY
MICR_ST_ERR_CREATE_EVENT
MICR_ST_BAD_DEVICE_NAME
MICR_ST_BAD_PARAMETER
MICR_ST_INSUFFICIENT_DISKSPACE
MICR_ST_USB_GET_DATA_FAILED
MICR_ST_INET_GET_DATA_FAILED
MICR_ST_HTTP_HEADER_NOT_FOUND

Remarks


When sending command “ClearPathExit” or command “ClearPathEntry” to the device, the device is trying to clear the
document path. If there is document in the path, the document is removed through the exit point if the command is
“ClearPathExit” or the document is removed through the entry point if the command is “ClearPathEntry.”

Advertising