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

Select your printer model

Parameters are refined by the selected printer.

addSymbol

Adds the display of the two-dimensional symbol to the command buffer.

Syntax

 
 
- (int) addSymbol:(NSString *)data type:(int)type level:(int)level width:(long)width height:(long)height dotX:(long)dotX dotY:(long)dotY quietZone:(int)quietZone;

Parameter

data

Specifies the two-dimensional symbol data as a string.

Specify a string in accordance with the standard of the two-dimensional symbol specified in type.

Type

Description

QR Code Model 1

After converting the string to shift JIS, perform the escape sequence processing, select the data type from the following, and perform encoding.

  • Numbers: 0 to 9
  • Alphanumeric characters: 0 to 9, A to Z, space, $, %, *, +, -, ., /, :
  • Kanji characters: Kanji characters that can be expressed in shift JIS
  • 8-bit byte data: 0x00 to 0xff

QR Code Model 2

When specifying binary data that cannot be expressed as a string, specify in the following escape sequence.

String

Description

\xnn

Control code (nn is specified in hexadecimals)

\\

Backslash

type

Specifies the type of the two-dimensional symbol.

Value

Description

EPOS2_SYMBOL_QRCODE_MODEL_1

QR Code Model 1

EPOS2_SYMBOL_QRCODE_MODEL_2

QR Code Model 2

level

Specifies the error revision level.

Value

Description

EPOS2_LEVEL_L

Error revision level L

EPOS2_LEVEL_M

Error revision level M

EPOS2_LEVEL_Q

Error revision level Q

EPOS2_LEVEL_H

Error revision level H

EPOS2_PARAM_DEFAULT

Select the default value (error revision level M).

width

Specifies the module width (in dots).

Value

Description

Integer from 1 to 255

Effective specification range of QR Code (initial value: 3)

Integer from 3 to 16

height

Specifies the module height (in dots).

Value

Description

Integer from 1 to 255

No effective specification range of QR Code. Since the QR Code is square, the specification of the height is ignored.

dotX

Specifies the origin of the x-coordinate for displaying the two-dimensional symbol (in dots).

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 origin of the y-coordinate for displaying the two-dimensional symbol (in dots).

Value

Description

Integer from 0 to 479

Effective specification range during landscape orientation

Integer from 0 to 799

Effective specification range during portrait orientation

quietZone

Specifies whether quiet zone assignment is enabled or disabled.

Value

Description

EPOS2_TRUE

Enabled

EPOS2_FALSE

Disabled

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.
  • In case there is overlapping with the display of text or image, the two-dimensional symbol is displayed right in front.
  • If the two-dimensional symbol data specified in data is not in accordance with the type of the two-dimensional symbol specified in type, an error is not returned in the return value, and the two-dimensional symbol is not displayed.
  • If quiet zone assignment is enabled, a dot white margin (quiet zone) that is four times the value specified in width is added at the top, bottom, left, and right of the two-dimensional symbol.
  • To enable quiet zone assignment, specify a value in dotX and dotY, with top left of the quiet zone as the origin.
 

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

Jump to the top