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

Select your printer model

Parameters are refined by the selected printer.

getPrinterSettingEx

Acquires the set value of the printer setting in JSON format.

This API error status is the API processing result.

The processing result of the devices using this API is notified to the callback method set by the setGetPrinterSettingExDelegate API of the Printer class.

Syntax

 
 
- (int) getPrinterSettingEx:(long)timeout;

Parameter

timeout

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

Value

Description

Integer from 5000 to 60000

Timeout period (in milliseconds)

EPOS2_PARAM_DEFAULT

Specifies the default value (30000).

Return value

Error status

Description

EPOS2_SUCCESS

The function was executed successfully.

EPOS2_ERR_PARAM

An invalid parameter was passed.

EPOS2_ERR_ILLEGAL

This API was called while no communication had been started.

EPOS2_ERR_MEMORY

Sufficient memory required for processing could not be allocated.

EPOS2_ERR_FAILURE

An unknown error occurred.

EPOS2_ERR_TYPE_INVALID

The device type is different.

EPOS2_ERR_PROCESSING

Could not run the process.

Supplementary explanation

  • 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 and USB.
  • This API cannot be used with SSL/TLS communication.
  • Since it takes time to send and receive large amounts of data over BLE connection, this API cannot be used with BLE connection.
  • If this API is executed in a non-supported printer, EPOS2_CODE_SUCCESS is stored in the setGetPrinterSettingExDelegate API code, and "" (blank character) is stored in jsonString.
 

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. getPrinterSettingEx

Jump to the top