1. TOP»
  2. Epson ePOS SDK for iOS »
  3. Epos2LineDisplay class »
  4. addDownloadImage

Select your printer model

Parameters are refined by the selected printer.

addDownloadImage

Adds the display of the image registered in addRegisterDownloadImage to the command buffer.

Syntax

 
 
- (int) addDownloadImage:(long)key1 key2:(long)key2 dotX:(long)dotX dotY:(long)dotY width:(long)width height:(long)height;

Parameter

key1

Specifies keycode 1 indicated in addRegisterDownloadImage.

Value

Description

Integer from 0 to 255

Keycode 1

key2

Specifies keycode 2 indicated in addRegisterDownloadImage.

Value

Description

Integer from 0 to 255

Keycode 2

dotX

Specifies the x-coordinate of the image display position, with the top left of the customer display as the origin.

Value

Description

Integer from 0 to 799

Effective specification range during landscape orientation

Integer from 0 to 479

Effective specification range during portrait orientation

dotY

Specifies the y-coordinate of the image display position, with the top left of the customer display as the origin.

Value

Description

Integer from 0 to 479

Effective specification range during landscape orientation

Integer from 0 to 799

Effective specification range during portrait orientation

width

Specifies the width display size (in dots) of the image.

Value

Description

Integer from 0 to 1440

Width display size (in dots) of the image

height

Specifies the height display size (in dots) of the image.

Value

Description

Integer from 0 to 1440

Height display size (in dots) of the image

Return value

Error status

Description

EPOS2_SUCCESS

The function was executed successfully.

EPOS2_ERR_PARAM

An invalid parameter was passed.

EPOS2_ERR_MEMORY

Sufficient memory required for processing could not be allocated.

EPOS2_ERR_FAILURE

An unknown error occurred.

Supplementary explanation

  • Can be used when the layout is specified in addCreateScreenCustom.
  • To display in the size of the original image, specify 0 in both the width and height parameters.
  • The image is not displayed if it does not fit into the display area.
  • The image specified by this API is displayed in front of the text or image being displayed during the execution of the API.
  • When using a transmission image, use data in the png format.
 

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. Epos2LineDisplay class »
  4. addDownloadImage

Jump to the top