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

Select your printer model

Parameters are refined by the selected printer.

setPrinterSettingEx

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

For the JSON used in this API, use the printer information JSON acquired with the getPrinterSettingEx API.

Do not use the printer information JSON acquired from another model.

Before executing the API, you can execute the verifyPassword API to make sure this API uses the correct password.

Execute the getPrinterSettingEx API after executing this API, and check that the printer settings have been changed correctly.

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 setSetPrinterSettingExDelegate API of the Printer class.

Do not execute this API in continuation without checking the processing result with the callback method.

Syntax

 
 
- (int) setPrinterSettingEx:(long)timeout 
jsonString:(NSString *)jsonString administratorPassword:(NSString *)administratorPassword;

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

jsonString

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

Refer to JSON_Spec_sheet_revx.pdf included in the package for more information.

administratorPassword

Specify the administrator password set in the printer.

Refer to the printer's Technical Reference Guide for the initial administrator password.

If no administrator password is set for the printer, specify "nil."

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.
  • Immediately after starting the printer, do not execute this API until the LED is lit.
    Execution takes time, and a timeout error may occur.
  • If communication with the printer is disconnected during execution of this API, the printer may become unable to operate. In such a case, turn the power supply to the printer off and then on again.
  • Communication with the printer disconnects as the printer automatically restarts during execution of this API. Reconnect as necessary.
    In a network environment that uses DHCP, the IP address may change due to restart of the printer.
    In such a case, search for the printer using Epos2Discovery class and reconnect.
    When connected via USB, the USB device node may change due to restart of the printer.
    If the identifier is omitted in the target parameter of connect ("USB:"), the connection status can be retained even if the device node changes.
  • 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.
  • When this API is used with the system configuration of a TM printer + DM-D + barcode scanner model Wi-Fi/Ethernet connection and POS terminal model, EPOS2_ERR_TYPE_INVALID is returned.
  • It may take some time to change printer settings depending on the printer used or the connection method with the printer.
  • If this API is executed in a non-supported printer, EPOS2_CODE_SUCCESS is stored in the setSetPrinterSettingExDelegate API code, but printer settings will not be executed.
 

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

Jump to the top