1. TOP»
  2. Epson ePOS SDK for iOS »
  3. Epos2Printer class »
  4. getPrinterSetting

Select your printer model

Parameters are refined by the selected printer.

getPrinterSetting

Acquires the set value of the printer setting.

The value acquired by this API is notified to the callback method specified in the delegate parameter.

Syntax

 
 
- (int) getPrinterSetting:(long)timeout
type:(int)Type
delegate:(id<Epos2PrinterSettingDelegate>)delegate;

Parameter

timeout

Specifies the timeout period before completion of command transmission in milliseconds.

Value

Description

Integer from 5000 to 600000

Timeout period (in milliseconds)

EPOS2_PARAM_DEFAULT

Specifies the default value (10000).

type

Specifies the printer setting item to be acquired.

Value

Description

EPOS2_PRINTER_SETTING_PAPERWIDTH

Paper width

EPOS2_PRINTER_SETTING_PRINTDENSITY

Print density

EPOS2_PRINTER_SETTING_PRINTSPEED

Print speed

delegate

Registers the callback method that returns the processing result of this API.

 
 
- (void) onGetPrinterSetting:(int)code type:(int)Type value:(int)value;
  • code
    The processing result is stored.

  • Error status

    Description

    EPOS2_CODE_SUCCESS

    Processed successfully.

    EPOS2_CODE_ERR_AUTORECOVER

    Automatic recovery error occurred.

    EPOS2_CODE_ERR_COVER_OPEN

    Cover open error occurred.

    EPOS2_CODE_ERR_CUTTER

    Auto cutter error occurred.

    EPOS2_CODE_ERR_MECHANICAL

    Mechanical error occurred.

    EPOS2_CODE_ERR_EMPTY

    No paper is left in the roll paper end detector.

    EPOS2_CODE_ERR_PARAM

    An invalid parameter was passed.

    EPOS2_CODE_ERR_MEMORY

    Memory necessary for processing could not be allocated.

    EPOS2_CODE_ERR_TIMEOUT

    Failed to communicate with the devices within the specified time.

    EPOS2_CODE_ERR_PROCESSING

    Could not run the process.

    EPOS2_CODE_ERR_ILLEGAL

    This API was called while no communication had been started.

    EPOS2_CODE_ERR_FAILURE

    An unknown error occurred.
  • type
    The processing result is stored.

  • Value

    Description

    EPOS2_PRINTER_SETTING_PAPERWIDTH

    Paper width

    EPOS2_PRINTER_SETTING_PRINTDENSITY

    Print density

    EPOS2_PRINTER_SETTING_PRINTSPEED

    Print speed
  • value
    The acquired set value of the printer setting is stored.

  • Value

    Description

    EPOS2_PRINTER_SETTING_PAPERWIDTH58_0

    Paper width 58 mm

    EPOS2_PRINTER_SETTING_PAPERWIDTH60_0

    Paper width 60 mm

    EPOS2_PRINTER_SETTING_PAPERWIDTH70_0

    Paper width 70 mm

    EPOS2_PRINTER_SETTING_PAPERWIDTH76_0

    Paper width 76 mm

    EPOS2_PRINTER_SETTING_PAPERWIDTH80_0

    Paper width 80 mm

    EPOS2_PRINTER_SETTING_PRINTDENSITYDIP

    Print density DIP switch setting

    EPOS2_PRINTER_SETTING_PRINTDENSITY70

    Print density 70%

    EPOS2_PRINTER_SETTING_PRINTDENSITY75

    Print density 75%

    EPOS2_PRINTER_SETTING_PRINTDENSITY80

    Print density 80%

    EPOS2_PRINTER_SETTING_PRINTDENSITY85

    Print density 85%

    EPOS2_PRINTER_SETTING_PRINTDENSITY90

    Print density 90%

    EPOS2_PRINTER_SETTING_PRINTDENSITY95

    Print density 95%

    EPOS2_PRINTER_SETTING_PRINTDENSITY100

    Print density 100%

    EPOS2_PRINTER_SETTING_PRINTDENSITY105

    Print density 105%

    EPOS2_PRINTER_SETTING_PRINTDENSITY110

    Print density 110%

    EPOS2_PRINTER_SETTING_PRINTDENSITY115

    Print density 115%

    EPOS2_PRINTER_SETTING_PRINTDENSITY120

    Print density 120%

    EPOS2_PRINTER_SETTING_PRINTDENSITY125

    Print density 125%

    EPOS2_PRINTER_SETTING_PRINTDENSITY130

    Print density 130%

    EPOS2_PRINTER_SETTING_PRINTSPEED1

    Print speed level 1

    EPOS2_PRINTER_SETTING_PRINTSPEED2

    Print speed level 2

    EPOS2_PRINTER_SETTING_PRINTSPEED3

    Print speed level 3

    EPOS2_PRINTER_SETTING_PRINTSPEED4

    Print speed level 4

    EPOS2_PRINTER_SETTING_PRINTSPEED5

    Print speed level 5

    EPOS2_PRINTER_SETTING_PRINTSPEED6

    Print speed level 6

    EPOS2_PRINTER_SETTING_PRINTSPEED7

    Print speed level 7

    EPOS2_PRINTER_SETTING_PRINTSPEED8

    Print speed level 8

    EPOS2_PRINTER_SETTING_PRINTSPEED9

    Print speed level 9

    EPOS2_PRINTER_SETTING_PRINTSPEED10

    Print speed level 10

    EPOS2_PRINTER_SETTING_PRINTSPEED11

    Print speed level 11

    EPOS2_PRINTER_SETTING_PRINTSPEED12

    Print speed level 12

    EPOS2_PRINTER_SETTING_PRINTSPEED13

    Print speed level 13

    EPOS2_PRINTER_SETTING_PRINTSPEED14

    Print speed level 14

    EPOS2_PRINTER_SETTING_PRINTSPEED15

    Print speed level 15

    EPOS2_PRINTER_SETTING_PRINTSPEED16

    Print speed level 16

    EPOS2_PRINTER_SETTING_PRINTSPEED17

    Print speed level 17

Return value

Error status

Description

EPOS2_SUCCESS

The function was executed successfully.

EPOS2_ERR_PARAM

An invalid parameter was passed.

EPOS2_ERR_FAILURE

An unknown error occurred.

Supplementary explanation

  • This API is not executed on the main thread. Execute it on the sub-thread.
  • This API cannot be used simultaneously with other APIs.
    After executing this API, do not execute any other API until the callback is returned.
  • Do not turn off the power supply to the printer while executing this API.
  • This API can be used in the system configuration of the TM printer model and customer display model.
    With the system configuration of the TM Printer + DM-D + barcode scanner model, this API can be used when connecting via Bluetooth or USB.
  • This API cannot be used with SSL/TLS communication.
 

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. Epos2Printer class »
  4. getPrinterSetting

Jump to the top