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

Select your printer model

Parameters are refined by the selected printer.

addLayout

Adds layout setting of the label sheet/black mark sheet to the command buffer.

Syntax

 
 
- (int) addLayout:(int)type width:(long)width height:(long)height marginTop:(long)marginTop marginBottom:(long)marginBottom offsetCut:(long)offsetCut offsetLabel:(long)offsetLabel;

Parameter

type

Specifies the paper type.

Value

Description

EPOS2_LAYOUT_RECEIPT

Receipt (without black mark)

EPOS2_LAYOUT_RECEIPT_BM

Receipt (with black mark)

EPOS2_LAYOUT_LABEL

Label sheet (without black mark)

EPOS2_LAYOUT_LABEL_BM

Label sheet (with black mark)

width

Specifies the paper width (in 0.1mm units).

Value

Description

TM Printer Models

POS Terminal Model

Integer from 1 to 10000

Integer from 290 to 600

Paper width (in 0.1 mm units)

height

Specifies the distance from the print reference mark to the next print reference mark (in 0.1mm units).

Sheet type

Value

Description

TM Printer Models

POS Terminal Model

Receipt (without black mark)

0

0

No distance specified (auto)

Receipt (with black mark)

0 to 10000

0 to 1550

Distance between the top edges of two consecutive black marks.

Label sheet (without black mark)

Distance between the top edges of two consecutive labels

Label sheet (with black mark)

Distance between the bottom edges of two consecutive black marks.

marginTop

Specifies the distance from the print reference mark to the top of the sheet (in 0.1mm units).

Sheet type

Value

Description

TM Printer Models

POS Terminal Model

Receipt (without black mark)

0

0

No distance specified (auto)

Receipt (with black mark)

-9999 to 10000

-150 to 1500

Distance from the top edge of the black mark to the top of the sheet

Label sheet (without black mark)

0 to 10000

0 to 1500

Distance from the top edge of the label to the top of the sheet

Label sheet (with black mark)

-9999 to 10000

-15 to 1500

Distance from the bottom edge of the black mark to the top of the sheet

marginBottom

Specifies the distance from the eject reference mark to the bottom edge of the printable area (in 0.1mm units).

Sheet type

Value

Description

TM Printer Models

POS Terminal Model

Receipt (without black mark)

0

0

No distance specified (auto)

Receipt (with black mark)

0

0

No distance specified (auto)

Label sheet (without black mark)

-9999 to 0

-15 to 0

Distance from the bottom edge of the label (A positive value represents the paper feed direction.)

Label sheet (with black mark)

-9999 to 10000

-15 to 15

Distance from the top of the black mark
(A positive value represents the paper feed direction.)

offsetCut

Specifies the distance from the eject reference mark to the cut position (in 0.1mm units).

Sheet type

Value

Description

TM Printer Models

POS Terminal Model

Receipt (without black mark)

0

0

No distance specified (auto)

Receipt (with black mark)

-9999 to 10000

-290 to 50

Distance from the top edge of the black mark to the cut position

Label sheet (without black mark)

0 to 10000

0 to 50

Distance from the bottom edge of the label to the cut position

Label sheet (with black mark)

0 to 10000

0 to 50

Distance from the top edge of the black mark to the cut position

offsetLabel

Specifies the distance from the eject reference mark to the bottom edge of the label (in 0.1mm units).

Sheet type

Value

Description

TM Printer Models

POS Terminal Model

Receipt (without black mark)

0

0

No distance specified (auto)

Receipt (with black mark)

0

0

No distance specified (auto)

Label sheet (without black mark)

0

0

No distance specified (auto)

Label sheet (with black mark)

0 to 10000

0 to 15

Distance from the top edge of the black mark to the bottom edge of a label

Return value

Error status

Description

EPOS2_SUCCESS

The function was executed successfully.

EPOS2_ERR_PARAM

An invalid parameter was passed.

EPOS2_ERR_MEMORY

Memory necessary for processing could not be allocated.

EPOS2_ERR_FAILURE

An unknown error occurred.

Supplementary explanation

  • This API does not work in the page mode.
  • Use this API at the "beginning of a line." If this API is used elsewhere, it will be ignored.
  • Available setting values vary by TM printer model. For more details, see the FS (L<Function 33> command.
    https://support.epson.net/publist/reference_en/
  • The available parameter values for each type of paper are listed below.
    The following table shows available values for TM printer models, and shows those for POS terminal models in parentheses.

Parameter

Receipt
(without black mark)

Label sheet
(without black mark)

Label sheet
(with black mark)

Receipt
(with black mark)

Symbol in diagram

width

1 to 10000 (290 to 600)

f

height

0 (0)

0 to 10000 (0 to 1550)

a

marginTop

0 (0)

0 to 10000
(0 to 1500)

-9999 to 10000
(-15 to 1500)

-9999 to 10000
(-150 to 1500)

b

marginBottom

0 (0)

-9999 to 0
(-15 to 0)

-9999 to 10000
(-15 to 15)

0 (0)

e

offsetCut

0 (0)

0 to 10000 (0 to 50)

-9999 to 10000
(-290 to 50)

c

offsetLabel

0 (0)

0 to 10000
(0 to 15)

d
Graphic
 

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

Jump to the top