1. TOP»
  2. Epson ePOS SDK for iOS »
  3. Epos2HybridPrinter class »
  4. cleanMicrReader

Select your printer model

Parameters are refined by the selected printer.

cleanMicrReader

Cleans the MICR mechanism.

Inserting a cleaning sheet after executing this API starts cleaning the MICR mechanism.

The processing result of this API is returned to the callback method set by the setReceiveEventDelegate API of the Epos2HybridPrinter class.

Syntax

 
 
- (int)cleanMicrReader:(long)timeout;

Parameter

timeout

Specifies the timeout period before completion of MICR mechanism cleaning in milliseconds.

Value

Description

Integer from 5000 to 600000

Timeout period (in milliseconds)

EPOS2_PARAM_DEFAULT

Specifies the default value (15000).

Return value

If the process succeeds, EPOS2_SUCCESS will be returned.

If the process fails, one of the following values be returned.

Error status

Description

EPOS2_SUCCESS

The function was executed successfully.

EPOS2_ERR_PARAM

An invalid parameter was passed.

EPOS2_ERR_UNSUPPORTED

The printer is not equipped with MICR.

EPOS2_ERR_ILLEGAL

This API was called while no communication had been started.

EPOS2_ERR_MEMORY

Necessary memory could not be allocated.

EPOS2_ERR_FAILURE

An unknown error occurred.

EPOS2_ERR_PROCESSING

Could not run the process.

Supplementary explanation

This API is not executed on the main thread. Execute it on the sub-thread.

 

Quick Access

  • [Name]
  • [Format]
  • [Range]
  • [Description]
  • [Notes]
Epson ePOS SDK includes patented or patent pending functions. The contents must not be disclosed to third parties.


Epson ePOS SDK for iOS

  1. TOP»
  2. Epson ePOS SDK for iOS »
  3. Epos2HybridPrinter class »
  4. cleanMicrReader

Jump to the top