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

Select your printer model

Parameters are refined by the selected printer.

addCreateScreenCustom

Adds the setting of the base window to the command buffer.

This API enables the specification of width and height in the screen configuration of the base window having customer display.

Syntax

 
 
- (int) addCreateScreenCustom:(int)mode column:(long)column row:(long)row;

Parameter

mode

Specifies the screen configuration of base window (text/image).

Value

Installation method

Screen configuration

EPOS2_LANDSCAPE_LAYOUT_MODE_1

Landscape
orientation

“Full screen”

The text/image is displayed on the entire page.

No division.

EPOS2_LANDSCAPE_LAYOUT_MODE_2

Landscape
orientation

“Vertical split”

Divided equally into left and right portions.

Left: Image, Right: Text

EPOS2_LANDSCAPE_LAYOUT_MODE_3

Landscape
orientation

“Vertical split”

Divided equally into left and right portions.

Left: Text, Right: Image

EPOS2_LANDSCAPE_LAYOUT_MODE_4

Landscape
orientation

“Horizontal split”

Divided equally into top and bottom portions.

Top: Text, Bottom: Image

EPOS2_LANDSCAPE_LAYOUT_MODE_5

Landscape
orientation

“Horizontal split”

Divided equally into top and bottom portions.

Top: Image, Bottom: Text

EPOS2_PORTRAIT_LAYOUT_MODE_1

Portrait
orientation

“Full screen”

The text/image is displayed on the entire page.

No division.

EPOS2_PORTRAIT_LAYOUT_MODE_2

Portrait
orientation

“Horizontal split”

Divided equally into top and bottom portions.

Top: Text, Bottom: Image

EPOS2_PORTRAIT_LAYOUT_MODE_3

Portrait
orientation

“Horizontal split”

Divided equally into top and bottom portions.

Top: Image, Bottom: Text

EPOS2_PORTRAIT_LAYOUT_MODE_4

Portrait
orientation

“Horizontal split 1:2”

Divided into top and bottom portions in the ratio of 1:2.

Top: Text, Bottom: Image

EPOS2_PORTRAIT_LAYOUT_MODE_5

Portrait
orientation

“Horizontal split 2:1”

Divided into top and bottom portions in the ratio of 2:1.

Top: Image, Bottom: Text

EPOS2_PORTRAIT_LAYOUT_MODE_6

Portrait
orientation

“Horizontal split 2:1”

Divided into top and bottom portions in the ratio of 2:1.

Top: Text, Bottom: Image

EPOS2_PORTRAIT_LAYOUT_MODE_7

Portrait
orientation

“Horizontal split 1:2”

Divided into top and bottom portions in the ratio of 1:2.

Top: Image, Bottom: Text

column

Specifies the width (number of columns) of the base window display area.

Value

Description

Integer from 1 to 44

Effective specification range during landscape orientation

Integer from 1 to 22

Effective specification range during portrait orientation

row

Specifies the height (number of rows) of the base window display area.

Value

Description

Integer from 1 to 13

Effective specification range during landscape orientation

Integer from 1 to 19

Effective specification range during portrait orientation

Return value

Error status

Description

EPOS2_SUCCESS

The function was executed successfully.

EPOS2_ERR_PARAM

An invalid parameter was specified.

EPOS2_ERR_MEMORY

Sufficient memory required for processing could not be allocated.

EPOS2_ERR_FAILURE

An unknown error occurred.

Supplementary explanation

  • If this API is executed, all items displayed in customer display are erased.
  • Ignored when a value out of the effective specification range is specified in column, row.
 

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

Jump to the top