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

Select your printer model

Parameters are refined by the selected printer.

addSymbol

Adds a 2D symbol print command to the command buffer.

Syntax

 
 
- (int) addSymbol:(NSString *)data type:(int)type level:(int)level width:(long)width height:(long)height size:(long)size;

Parameter

data

Specifies 2D symbol data as a text string.

Specify a string in accordance with the standard of the 2D symbol specified in type.

Type

Description

Standard PDF417

Converts the string into UTF-8, processes the escape sequence(s), and encodes the data.
The maximum number of code words in the data area is 928, the maximum number of code words in a single stage is 30, and the maximum number of stages is 90.

Truncated PDF417

QR Code Model 1

Converts the string into JIS, processes the escape sequence(s), and encodes the data by choosing the data type from the following:

  • Figure: 0 to 9
  • Alphanumeric: 0 to 9, A to Z, blank space, $, %, *, +, -, ., /, :
  • Kanji: Characters which can be represented with Shift JIS codes
  • 8-bit byte data: 0x00 to 0xff

QR Code Model 2

QR Code Micro

MaxiCode Mode 2

Converts the string into UTF-8, processes the escape sequence(s), and encodes the data.
In Mode 2 or 3, if the first data is ][)>\x1e01\x1dyy ("yy" is a 2-digit figure), this is processed as the message header and the second and succeeding data sequence is processed as the primary message.
Otherwise, the primary message starts with the fist data.
For the mode 2, specify the primary message in the following format:

  • Zip code (1- to 9-digit figure) GS:(\x1d)
  • ISO country code (1- to 3-digit figure) GS:(\x1d)
  • Service class code (1- to 3-digit figure)

For the mode 3, specify the primary message in the following format:

  • Zip code (data which can be converted with 1 to 6 code sets A) GS (\x1d)
  • ISO country code (1- to 3-digit figure) GS (\x1d)
  • Service class code (1- to 3-digit figure)

MaxiCode Mode 3

MaxiCode Mode 4

MaxiCode Mode 5

MaxiCode Mode 6

GS1 DataBar Stacked

Converts the string into UTF-8, processes the escape sequence(s), and encodes the data.
Specify a 13-digit product ID (GTIN) excluding the application ID (AI) and check digit.

GS1 DataBar Stacked Omnidirectional

GS1 DataBar Expanded Stacked

Converts the string into UTF-8, processes the escape sequence(s), and encodes the data.
The application ID (AI) can be put in parentheses.
The parentheses are used as print characters for HRI and not encoded as data.
To encode the following characters, specify the corresponding 2-digit code starting with { :

  • FNC1: {1
  • (: {(
  • ): }{)

Aztec Code

Converts the string into UTF-8, processes the escape sequence(s), and encodes the data.

DataMatrix

Converts the string into UTF-8, processes the escape sequence(s), and encodes the data.

When specifying binary data which cannot be represented as a string, use the following escape sequences.

String

Description

\xnn

Control code (set nn in hexadecimal)

\\

Back slash

type

Specifies the 2D symbol type.

Value

Description

EPOS2_SYMBOL_PDF417_STANDARD

Standard PDF417

EPOS2_SYMBOL_PDF417_TRUNCATED

Truncated PDF417

EPOS2_SYMBOL_QRCODE_MODEL_1

QR Code Model 1

EPOS2_SYMBOL_QRCODE_MODEL_2

QR Code Model 2

EPOS2_SYMBOL_QRCODE_MICRO

QR Code Micro

EPOS2_SYMBOL_MAXICODE_MODE_2

MaxiCode Mode 2

EPOS2_SYMBOL_MAXICODE_MODE_3

MaxiCode Mode 3

EPOS2_SYMBOL_MAXICODE_MODE_4

MaxiCode Mode 4

EPOS2_SYMBOL_MAXICODE_MODE_5

MaxiCode Mode 5

EPOS2_SYMBOL_MAXICODE_MODE_6

MaxiCode Mode 6

EPOS2_SYMBOL_GS1_DATABAR_STACKED

GS1 DataBar Stacked

EPOS2_SYMBOL_GS1_DATABAR_STACKED_
OMNIDIRECTIONAL

GS1 DataBar Stacked Omnidirectional

EPOS2_SYMBOL_GS1_DATABAR_EXPANDED_STACKED

GS1 DataBar Expanded Stacked

EPOS2_SYMBOL_AZTECCODE_FULLRANGE

Aztec Code Full-Range mode

EPOS2_SYMBOL_AZTECCODE_COMPACT

Aztec Code Compact mode

EPOS2_SYMBOL_DATAMATRIX_SQUARE

DataMatrix Square

EPOS2_SYMBOL_DATAMATRIX_RECTANGLE_8

DataMatrix Rectangle, 8 lines

EPOS2_SYMBOL_DATAMATRIX_RECTANGLE_12

DataMatrix Rectangle, 12 lines

EPOS2_SYMBOL_DATAMATRIX_RECTANGLE_16

DataMatrix Rectangle, 16 lines

level

Specifies the error correction level.

Specify a value in accordance with the 2D symbol type.

Specify "EPOS2_PARAM_DEFAULT" for MaxiCode, 2D GS1 DataBar, and DataMatrix.

  • PDF417

  • Value

    Description

    EPOS2_LEVEL_0

    Error correction level 0

    EPOS2_LEVEL_1

    Error correction level 1

    EPOS2_LEVEL_2

    Error correction level 2

    EPOS2_LEVEL_3

    Error correction level 3

    EPOS2_LEVEL_4

    Error correction level 4

    EPOS2_LEVEL_5

    Error correction level 5

    EPOS2_LEVEL_6

    Error correction level 6

    EPOS2_LEVEL_7

    Error correction level 7

    EPOS2_LEVEL_8

    Error correction level 8

    EPOS2_PARAM_DEFAULT

    Specifies the default value (Error correction level 1).

    EPOS2_PARAM_UNSPECIFIED

    <Obsolete> Not specify.
  • QR Code

  • Value

    Description

    EPOS2_LEVEL_L

    Error correction level L

    EPOS2_LEVEL_M

    Error correction level M

    EPOS2_LEVEL_Q

    Error correction level Q

    EPOS2_LEVEL_H

    Error correction level H

    EPOS2_PARAM_DEFAULT

    Specifies the default value (Error correction level M).

    EPOS2_PARAM_UNSPECIFIED

    <Obsolete> Not specify.

  • Aztec Code

  • Value

    Description

    Integer from 5 to 95

    Error correction level (in percents)

    EPOS2_PARAM_DEFAULT

    Specifies the default value (Error correction level 23).

    EPOS2_PARAM_UNSPECIFIED

    <Obsolete> Not specify.

width

Specifies the module width.

An integer from 1 to 255 can be specified.

When "EPOS2_PARAM_UNSPECIFIED" is specified, the current setting is retained.

The range differs depending on the 2D symbol type.

2D symbol type

Valid value

Default value

PDF417

2 to 8

3

QR Code

3 to 16

3

MaxiCode

1 to 255 (Ignored)

2D GS1 DataBar

2 to 8

2

Aztec Code

2 to 16

3

DataMatrix

2 to 16

3

height

Specifies the module height.

An integer from 1 to 255 can be specified.

When "EPOS2_PARAM_UNSPECIFIED" is specified, the current setting is retained.

The range differs depending on the 2D symbol type.

2D symbol type

Valid value

Default value

PDF417

2 to 8 (Scaling factor for width)

3

QR Code

1 to 255 (Ignored)

MaxiCode

2D GS1 DataBar

Aztec Code

DataMatrix

QR Code, MaxiCode, 2D GS1 DataBar, Aztec Code, and DataMatrix are ignored.

size

Specifies the maximum size of the 2D symbol.

An integer from 0 to 65535 can be specified.

When "EPOS2_PARAM_UNSPECIFIED" is specified, the current setting is retained.

The range differs depending on the 2D symbol type.

2D symbol type

Default value

Description

PDF417

0 (auto)

Specifies the number of code words per stage.

QR Code

0 to 65535 (Ignored)

MaxiCode

0 to 65535 (Ignored)

2D GS1 DataBar

Expanded Stacked

0 (auto)

Specifies the maximum width of the 2D symbol (106 or more).

Other

0 to 65535 (Ignored)

Aztec Code

0 to 65535 (Ignored)

DataMatrix

0 to 65535 (Ignored)

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

  • Use this API at the "beginning of a line."
  • When the 2D symbol data specified in data does not conform to the 2D symbol type specified in type, an error will not be returned in the return value and the 2D symbol will not be printed.
  • During ESC/POS control, specifying values outside the valid ranges for the width and height parameters results in default value printing.
  • During ePOS-Device XML control, specifying values outside the valid ranges for the width and height parameters causes sendData to return EPOS2_ERR_FAILURE.
 

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

Jump to the top