4.2. ISCBBuilder

Provides a function to generate printer control commands.

  • Property

    Name

    Contents

    commands

    Generated commands.

  • Method

    Name

    Contents

    beginDocument

    Begin document command is generated and added to the command buffer.

    endDocument

    End document command is generated and added to the command buffer.

    appendInitialization

    Initialization command is generated and added to the command buffer.

    appendData

    Data (Text and Command) is added to the command buffer.

    appendRawData

    Raw data (Text and Command) is added to the command buffer.

    appendFontStyle

    Select command of the font style is generated and added to the command buffer.

    appendCodePage

    Select command of the code page is generated and added to the command buffer.

    appendInternational

    Select command of the international character mode is generated and added to the command buffer.

    appendLineFeed

    Line feed command is generated and added to the command buffer.

    appendUnitFeed

    Unit feed command is generated and added to the command buffer.

    appendCharacterSpace

    Set command of the character space is generated and added to the command buffer.

    appendLineSpace

    Set command of the line space is generated and added to the command buffer.

    appendTopMargin

    Set command of the top margin is generated and added to the command buffer.

    appendEmphasis

    Select command of the emphasis mode is generated and added to the command buffer.

    appendInvert

    Select command of the invert mode is generated and added to the command buffer.

    appendMultiple

    Select command of the multiple mode is generated and added to the command buffer.

    appendUnderLine

    Select command of the underline mode is generated and added to the command buffer.

    appendLogo

    Print command of the logo is generated and added to the command buffer.

    appendAbsolutePosition

    Absolute position command is generated and added to the command buffer.

    appendAlignment

    Alignment command is generated and added to the command buffer.

    appendHorizontalTabPosition

    Generates a clear command, and then adds it to the command buffer.

    appendCutPaper

    Paper cut command is generated and added to the command buffer.

    appendPeripheral

    Cash drawer command is generated and added to the command buffer.

    appendSound

    Sound/Buzzer command is generated and added to the command buffer.

    appendBarcodeData

    Print command of the barcode is generated and added to the command buffer.

    appendBarcodeDataWithAbsolutePosition

    Print command of the absolute position barcode is generated and added to the command buffer.

    appendBarcodeDataWithAlignment

    Print command of the alignment barcode is generated and added to the command buffer.

    appendPdf417Data

    Print command of the PDF417 is generated and added to the command buffer.

    appendPdf417DataWithAbsolutePosition

    Print command of the absolute position PDF417 is generated and added to the command buffer.

    appendPdf417DataWithAlignment

    Print command of the alignment PDF417 is generated and added to the command buffer.

    appendQrCodeData

    Print command of the QR code is generated and added to the command buffer.

    appendQrCodeDataWithAbsolutePosition

    Print command of the absolute position QR code is generated and added to the command buffer.

    appendQrCodeDataWithAlignment

    Print command of the alignment QR code is generated and added to the command buffer.

    appendBitmap

    Print command of the bitmap is generated and added to the command buffer.

    appendBitmapWithAbsolutePosition

    Print command of the absolute position bitmap is generated and added to the command buffer.

    appendBitmapWithAlignment

    Print command of the alignment bitmap is generated and added to the command buffer.

    appendBlackMark

    Black mark detection command is generated and added to the command buffer.

    appendLabel

    Gap detection command for die-cut label paper, etc is generated and added to the command buffer.

    beginPageMode

    Begin page mode command is generated and added to the command buffer.

    endPageMode

    End page mode command is generated and added to the command buffer.

    appendPageModeVerticalAbsolutePosition

    Vertical absolute position in page mode command is generated and added to the command buffer.

    appendPageModeRotation

    Print direction in page mode command is generated and added to the command buffer.

    appendPrintableArea

    Set command of the printable area is generated and added to the command buffer.

    appendCjkUnifiedIdeographFont

    A command to set the UTF-8 CJK Unified Ideograph font is generated and added to the command buffer.

    appendHoldPrint

    A command to specify the hold print control by the printer firmware is generated and added to the command buffer.

    appendPaperPresentStatus

    A command to specify hold print status is generated and added to the command buffer.

Supported method for each model.

Model/Emulation

mC-Print2 mC-Print3 mC-Label3 mPOP FVP10 TSP100IV TSP100IV SK TSP100IIIW TSP100IIIBITSP100IIIU TSP100IIU+ TSP100ECO TSP100U TSP100GTTSP100LAN TSP650II TSP650IISK TSP700II TSP800IISM-S210i SM-S220i SM-S230i SM-T300i/T300 SM-T400i BSC10 SM-L200 SM-L300 SP700
StarPRNT StarPRNT StarPRNT StarPRNT StarLine StarPRNT StarPRNT StarGraphic StarGraphic StarGraphic StarGraphic StarGraphic StarGraphic StarGraphic StarGraphic StarLine StarLine StarLine StarLine StarPRNT EscPosMobile StarPRNT EscPosMobile StarPRNT EscPosMobile StarPRNT EscPosMobile StarPRNT EscPosMobile EscPos StarPRNT StarPRNT StarDotImpact

beginDocument

endDocument

appendInitialization

- - - - - - - -

appendData

- - - - - - - -

appendRawData

appendFontStyle

- - - - - - - - - - - - -

appendCodePage

- - - - - - - -

appendInternational

- - - - - - - -

appendLineFeed

- - - - - - - -

appendUnitFeed

[1] [1] [1] [1] [1] [1] [1] [1]

appendCharacterSpace

- - - - - - - -

appendLineSpace

- - - - - - - -

appendTopMargin

- [2][3] - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

appendEmphasis

- - - - - - - -

appendInvert

- - - - - - - -

appendMultiple

- - - - - - - -

appendMultipleHeight

- - - - - - - -

appendMultipleWidth

- - - - - - - -

appendUnderLine

- - - - - - - -

appendLogo

- - - - - - - - [4] [4] [4] [4] [4]

appendAbsolutePosition

- - - - - - - -

appendAlignment

- - - - - - - -

appendHorizontalTabPosition

- - - - - - - - - - - - -

appendCutPaper

[5] [5] [5] [5] [5] [5] [5] [5] [5] [5] [5] [5]

appendPeripheral

- - - - - - - - - - - -

appendSound

- - - - - - - - - - - -

appendBarcodeData

[6]
-

appendBarcodeDataWithAbsolutePosition

[6]
-

appendBarcodeDataWithAlignment

[6]
[7] [7] [7] [7] [7] [7] [7] [7] [7] [7] [7] [7] [7] -

appendPdf417Data

-

appendPdf417DataWithAbsolutePosition

-

appendPdf417DataWithAlignment

[7] [7] [7] [7] [7] [7] [7] [7] [7] [7] [7] [7] [7] -

appendQrCodeData

-

appendQrCodeDataWithAbsolutePosition

-

appendQrCodeDataWithAlignment

[7] [7] [7] [7] [7] [7] [7] [7] [7] [7] [7] [7] [7] -

appendBitmap

[8] [8] [8] [8] [8]

appendBitmapWithAbsolutePosition

[8] [8] [8] [8] [8]

appendBitmapWithAlignment

[7] [7] [7] [7] [7] [7] [7] [7] [7][8] [7][8] [7][8] [7][8] [7][8]

appendBlackMark

- - - - - - - - - - - - - - - - - - - - - [9][10] [11] [9][10] [11] [9][10] [10][11]

appendLabel

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

beginPageMode

- - - - - - - - [13] - -

endPageMode

- - - - - - - - [13] - -

appendPageModeVerticalAbsolutePosition

- - - - - - - - [13] - -

appendPageModeRotation

- - - - - - - - [13] - -

appendPrintableArea

- - - - - - - - - - -

appendCjkUnifiedIdeographFont

- - - - - - - - - - [12] - - - - - - - - - - - - - - - -

appendHoldPrint

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

appendPaperPresentStatus

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
[1]

Do not append data, append unit feed command only.

[2]

When the top margin is set to 10 mm or less, the paper length (cut length) should not exceed 50mm. (If the cut paper remains at the paper-exit, a paper jam may occur. There is no limitation when the cut paper is removed.)

[3]

MCP30 is not supported.

[5]

Without paper cut.

[6]

Confirm that the printed barcode can be read properly in real environment.

[7]

Always print from left side.

[8]

The maximum vertical direction printing area is 30cm (2400 dot).

[9]

Only the front black mark can set enabled or disabled. Need to change printer setting to enable the back black mark (SM-T300i/T300 does not support the back black mark). Refer to hardware manual for how to change.

[10]

Library version 1.14.0 or later is required

[11]

Need to change printer setting to enable the black mark. Refer to hardware manual for how to change.

[12]

JP2/TW model with Firmware version 4.0 or later is required.

[13]

F/W Version 7.1 or later is required.

4.2.1. SCBInitializationType

Initialization constants

  • Declaration

    typedef NS_ENUM(NSUInteger, SCBInitializationType) {
        SCBInitializationTypeCommand
    };
    
  • Constants

    Name

    Contents

    SCBInitializationTypeCommand

    Command initialization

4.2.2. SCBFontStyleType

Font style constants

  • Declaration

    typedef NS_ENUM(NSUInteger, SCBFontStyleType) {
        SCBFontStyleTypeA,
        SCBFontStyleTypeB
    };
    
  • Constants

    Name

    Contents

    SCBFontStyleTypeA

    Font-A (12 x 24 dots) / Specify 7 x 9 font (half dots)

    SCBFontStyleTypeB

    Font-B (9 x 24 dots) / Specify 5 x 9 font (2P-1)

4.2.3. SCBCodePageType

Code Page constants

  • Declaration

    typedef NS_ENUM(NSUInteger, SCBCodePageType) {
        SCBCodePageTypeCP437,
        SCBCodePageTypeCP737,
        SCBCodePageTypeCP772,
        SCBCodePageTypeCP774,
        SCBCodePageTypeCP851,
        SCBCodePageTypeCP852,
        SCBCodePageTypeCP855,
        SCBCodePageTypeCP857,
        SCBCodePageTypeCP858,
        SCBCodePageTypeCP860,
        SCBCodePageTypeCP861,
        SCBCodePageTypeCP862,
        SCBCodePageTypeCP863,
        SCBCodePageTypeCP864,
        SCBCodePageTypeCP865,
        SCBCodePageTypeCP866,
        SCBCodePageTypeCP869,
        SCBCodePageTypeCP874,
        SCBCodePageTypeCP928,
        SCBCodePageTypeCP932,
        SCBCodePageTypeCP998,
        SCBCodePageTypeCP999,
        SCBCodePageTypeCP1001,
        SCBCodePageTypeCP1250,
        SCBCodePageTypeCP1251,
        SCBCodePageTypeCP1252,
        SCBCodePageTypeCP2001,
        SCBCodePageTypeCP3001,
        SCBCodePageTypeCP3002,
        SCBCodePageTypeCP3011,
        SCBCodePageTypeCP3012,
        SCBCodePageTypeCP3021,
        SCBCodePageTypeCP3041,
        SCBCodePageTypeCP3840,
        SCBCodePageTypeCP3841,
        SCBCodePageTypeCP3843,
        SCBCodePageTypeCP3844,
        SCBCodePageTypeCP3845,
        SCBCodePageTypeCP3846,
        SCBCodePageTypeCP3847,
        SCBCodePageTypeCP3848,
        SCBCodePageTypeUTF8,
        SCBCodePageTypeBlank
    };
    
  • Constants

    Name

    Contents

    SCBCodePageTypeCP437

    CodePage 437 (USA, Std. Europe)

    SCBCodePageTypeCP737

    Codepage 737 (Greek)

    SCBCodePageTypeCP772

    Codepage 772 (Lithuanian)

    SCBCodePageTypeCP774

    Codepage 774 (Lithuanian)

    SCBCodePageTypeCP851

    Codepage 851 (Greek)

    SCBCodePageTypeCP852

    Codepage 852 (Latin-2)

    SCBCodePageTypeCP855

    Codepage 855 (Cyrillic Bulgarian)

    SCBCodePageTypeCP857

    Codepage 857 (Turkey)

    SCBCodePageTypeCP858

    Codepage 858 (Multilingual)

    SCBCodePageTypeCP860

    Codepage 860 (Portuguese)

    SCBCodePageTypeCP861

    Codepage 861 (Icelandic)

    SCBCodePageTypeCP862

    Codepage 862 (Israel (Hebrew))

    SCBCodePageTypeCP863

    Codepage 863 (Canadian French)

    SCBCodePageTypeCP864

    Codepage 864 (Arabic)

    SCBCodePageTypeCP865

    Codepage 865 (Nordic)

    SCBCodePageTypeCP866

    Codepage 866 (Cyrillic Russian)

    SCBCodePageTypeCP869

    Codepage 869 (Greek)

    SCBCodePageTypeCP874

    Codepage 874 (Thai)

    SCBCodePageTypeCP928

    Codepage 928 (Greek)

    SCBCodePageTypeCP932

    Katakana

    SCBCodePageTypeCP998

    Normal

    SCBCodePageTypeCP999

    Codepage 1252 (Windows Latin-1)

    SCBCodePageTypeCP1001

    Codepage 1001 (Arabic)

    SCBCodePageTypeCP1250

    Codepage 1250 (Windows Latin-2)

    SCBCodePageTypeCP1251

    Codepage 1251 (Windows Cyrillic)

    SCBCodePageTypeCP1252

    Codepage 1252 (Windows Latin-1)

    SCBCodePageTypeCP2001

    Codepage 2001 (Lithuanian-KBL)

    SCBCodePageTypeCP3001

    Codepage 3001 (Estonian-1)

    SCBCodePageTypeCP3002

    Codepage 3002 (Estonian-2)

    SCBCodePageTypeCP3011

    Codepage 3011 (Latvian-1)

    SCBCodePageTypeCP3012

    Codepage 3012 (Latvian-2)

    SCBCodePageTypeCP3021

    Codepage 3021 (Bulgarian)

    SCBCodePageTypeCP3041

    Codepage 3041 (Maltese)

    SCBCodePageTypeCP3840

    Codepage 3840 (IBM-Russian)

    SCBCodePageTypeCP3841

    Codepage 3841 (Gost)

    SCBCodePageTypeCP3843

    Codepage 3843 (Polish)

    SCBCodePageTypeCP3844

    Codepage 3844 (CS2)

    SCBCodePageTypeCP3845

    Codepage 3845 (Hungarian)

    SCBCodePageTypeCP3846

    Codepage 3846 (Turkish)

    SCBCodePageTypeCP3847

    Codepage 3847 (Brazil-ABNT)

    SCBCodePageTypeCP3848

    Codepage 3848 (Brazil-ABICOMP)

    SCBCodePageTypeUTF8

    UTF-8

    SCBCodePageTypeBlank

    User Setting Blank Code Page

4.2.4. SCBInternationalType

International character constants

  • Declaration

    typedef NS_ENUM(NSUInteger, SCBInternationalType) {
        SCBInternationalTypeUSA,
        SCBInternationalTypeFrance,
        SCBInternationalTypeGermany,
        SCBInternationalTypeUK,
        SCBInternationalTypeDenmark,
        SCBInternationalTypeSweden,
        SCBInternationalTypeItaly,
        SCBInternationalTypeSpain,
        SCBInternationalTypeJapan,
        SCBInternationalTypeNorway,
        SCBInternationalTypeDenmark2,
        SCBInternationalTypeSpain2,
        SCBInternationalTypeLatinAmerica,
        SCBInternationalTypeKorea,
        SCBInternationalTypeIreland,
        SCBInternationalTypeLegal
    };
    
  • Constants

    Name

    Contents

    SCBInternationalTypeUSA

    USA

    SCBInternationalTypeFrance

    France

    SCBInternationalTypeGermany

    Germany

    SCBInternationalTypeUK

    UK

    SCBInternationalTypeDenmark

    Denmark

    SCBInternationalTypeSweden

    Sweden

    SCBInternationalTypeItaly

    Italy

    SCBInternationalTypeSpain

    Spain

    SCBInternationalTypeJapan

    Japan

    SCBInternationalTypeNorway

    Norway

    SCBInternationalTypeDenmark2

    Denmark2

    SCBInternationalTypeSpain2

    Spain2

    SCBInternationalTypeLatinAmerica

    Latin America

    SCBInternationalTypeKorea

    Korea

    SCBInternationalTypeIreland

    Ireland

    SCBInternationalTypeLegal

    Legal

4.2.5. SCBLogoSize

Logo size constants

  • Declaration

    typedef NS_ENUM(NSUInteger, SCBLogoSize) {
        SCBLogoSizeNormal,
        SCBLogoSizeDoubleWidth,
        SCBLogoSizeDoubleHeight,
        SCBLogoSizeDoubleWidthDoubleHeight
    };
    
  • Constants

    Name

    Contents

    SCBLogoSizeNormal

    Normal

    SCBLogoSizeDoubleWidth

    Double Width

    SCBLogoSizeDoubleHeight

    Double Height

    SCBLogoSizeDoubleWidthDoubleHeight

    Double Width / Height

4.2.6. SCBAlignmentPosition

Alignment position constants

  • Declaration

    typedef NS_ENUM(NSUInteger, SCBAlignmentPosition) {
        SCBAlignmentPositionLeft,
        SCBAlignmentPositionCenter,
        SCBAlignmentPositionRight
    };
    
  • Constants

    Name

    Contents

    SCBAlignmentPositionLeft

    Left alignment

    SCBAlignmentPositionCenter

    Center alignment

    SCBAlignmentPositionRight

    Right alignment

4.2.7. SCBCutPaperAction

Paper cut constants

  • Declaration

    typedef NS_ENUM(NSInteger, SCBCutPaperAction) {
        SCBCutPaperActionFullCut,
        SCBCutPaperActionPartialCut,
        SCBCutPaperActionFullCutWithFeed,
        SCBCutPaperActionPartialCutWithFeed
    };
    
  • Constants

    Name

    Contents

    SCBCutPaperActionFullCut

    Full Cut

    SCBCutPaperActionPartialCut

    Partial Cut

    SCBCutPaperActionFullCutWithFeed

    Full Cut with Feed

    SCBCutPaperActionPartialCutWithFeed

    Partial Cut with Feed

4.2.8. SCBPeripheralChannel

Cash drawer channel constants

  • Declaration

    typedef NS_ENUM(NSInteger, SCBPeripheralChannel) {
        SCBPeripheralChannelNo1,
        SCBPeripheralChannelNo2
    };
    
  • Constants

    Name

    Contents

    SCBPeripheralChannelNo1

    Channel1

    SCBPeripheralChannelNo2

    Channel2

4.2.9. SCBSoundChannel

Sound/Buzzer channel constants

  • Declaration

    typedef NS_ENUM(NSInteger, SCBSoundChannel) {
        SCBSoundChannelNo1,
        SCBSoundChannelNo2
    };
    
  • Constants

    Name

    Contents

    SCBSoundChannelNo1

    Channel1

    SCBSoundChannelNo2

    Channel2

4.2.10. SCBBarcodeSymbology

Barcode symbology constants

  • Declaration

    typedef NS_ENUM(NSUInteger, SCBBarcodeSymbology) {
        SCBBarcodeSymbologyUPCE,
        SCBBarcodeSymbologyUPCA,
        SCBBarcodeSymbologyJAN8,
        SCBBarcodeSymbologyJAN13,
        SCBBarcodeSymbologyCode39,
        SCBBarcodeSymbologyITF,
        SCBBarcodeSymbologyCode128,
        SCBBarcodeSymbologyCode93,
        SCBBarcodeSymbologyNW7
    };
    
  • Constants

    Name

    Contents

    SCBBarcodeSymbologyUPCE

    UPC-E

    SCBBarcodeSymbologyUPCA

    UPC-A

    SCBBarcodeSymbologyJAN8

    JAN/EAN8

    SCBBarcodeSymbologyJAN13

    JAN/EAN13

    SCBBarcodeSymbologyCode39

    Code39

    SCBBarcodeSymbologyITF

    ITF

    SCBBarcodeSymbologyCode128

    Code128

    SCBBarcodeSymbologyCode93

    Code93

    SCBBarcodeSymbologyNW7

    NW7

4.2.11. SCBBarcodeWidth

Barcode width constants

By specifying ExtMode, the barcode mode conforming to each command specification is set.

  • Declaration

    typedef NS_ENUM(NSUInteger, SCBBarcodeWidth) {
        SCBBarcodeWidthMode1,
        SCBBarcodeWidthMode2,
        SCBBarcodeWidthMode3,
        SCBBarcodeWidthMode4,
        SCBBarcodeWidthMode5,
        SCBBarcodeWidthMode6,
        SCBBarcodeWidthMode7,
        SCBBarcodeWidthMode8,
        SCBBarcodeWidthMode9,
        SCBBarcodeWidthExtMode1,
        SCBBarcodeWidthExtMode2,
        SCBBarcodeWidthExtMode3,
        SCBBarcodeWidthExtMode4,
        SCBBarcodeWidthExtMode5,
        SCBBarcodeWidthExtMode6,
        SCBBarcodeWidthExtMode7,
        SCBBarcodeWidthExtMode8,
        SCBBarcodeWidthExtMode9
    };
    
  • Constants

    Name

    Contents

    Library version

    SCBBarcodeWidthMode1

    Mode1

    1.3.0+

    SCBBarcodeWidthMode2

    Mode2

    1.3.0+

    SCBBarcodeWidthMode3

    Mode3

    1.3.0+

    SCBBarcodeWidthMode4

    Mode4

    1.3.0+

    SCBBarcodeWidthMode5

    Mode5

    1.3.0+

    SCBBarcodeWidthMode6

    Mode6

    1.3.0+

    SCBBarcodeWidthMode7

    Mode7

    1.3.0+

    SCBBarcodeWidthMode8

    Mode8

    1.3.0+

    SCBBarcodeWidthMode9

    Mode9

    1.3.0+

    SCBBarcodeWidthExtMode1

    ExtMode1

    1.13.0+

    SCBBarcodeWidthExtMode2

    ExtMode2

    1.13.0+

    SCBBarcodeWidthExtMode3

    ExtMode3

    1.13.0+

    SCBBarcodeWidthExtMode4

    ExtMode4

    1.13.0+

    SCBBarcodeWidthExtMode5

    ExtMode5

    1.13.0+

    SCBBarcodeWidthExtMode6

    ExtMode6

    1.13.0+

    SCBBarcodeWidthExtMode7

    ExtMode7

    1.13.0+

    SCBBarcodeWidthExtMode8

    ExtMode8

    1.13.0+

    SCBBarcodeWidthExtMode9

    ExtMode9

    1.13.0+

4.2.12. SCBPdf417Level

PDF417 ECC (security level) constants

  • Declaration

    typedef NS_ENUM(NSUInteger, SCBPdf417Level) {
        SCBPdf417LevelECC0,
        SCBPdf417LevelECC1,
        SCBPdf417LevelECC2,
        SCBPdf417LevelECC3,
        SCBPdf417LevelECC4,
        SCBPdf417LevelECC5,
        SCBPdf417LevelECC6,
        SCBPdf417LevelECC7,
        SCBPdf417LevelECC8
    };
    
  • Constants

    Name

    Contents

    SCBPdf417LevelECC0

    Level0

    SCBPdf417LevelECC1

    Level1

    SCBPdf417LevelECC2

    Level2

    SCBPdf417LevelECC3

    Level3

    SCBPdf417LevelECC4

    Level4

    SCBPdf417LevelECC5

    Level5

    SCBPdf417LevelECC6

    Level6

    SCBPdf417LevelECC7

    Level7

    SCBPdf417LevelECC8

    Level8

4.2.13. SCBQrCodeModel

QR code model constants

  • Declaration

    typedef NS_ENUM(NSUInteger, SCBQrCodeModel) {
        SCBQrCodeModelNo1,
        SCBQrCodeModelNo2
    };
    
  • Constants

    Name

    Contents

    SCBQrCodeModelNo1

    Model1

    SCBQrCodeModelNo2

    Model2

4.2.14. SCBQrCodeLevel

QR code mistake correction level constants

  • Declaration

    typedef NS_ENUM(NSUInteger, SCBQrCodeLevel) {
        SCBQrCodeLevelL,
        SCBQrCodeLevelM,
        SCBQrCodeLevelQ,
        SCBQrCodeLevelH
    };
    
  • Constants

    Name

    Contents

    SCBQrCodeLevelL

    Level L

    SCBQrCodeLevelM

    Level M

    SCBQrCodeLevelQ

    Level Q

    SCBQrCodeLevelH

    Level H

4.2.15. SCBBitmapConverterRotation

Bitmap rotation constants

  • Declaration

    typedef NS_ENUM(NSUInteger, SCBBitmapConverterRotation) {
        SCBBitmapConverterRotationNormal,
        SCBBitmapConverterRotationRight90,
        SCBBitmapConverterRotationLeft90,
        SCBBitmapConverterRotationRotate180
    };
    
  • Constants

    Name

    Contents

    SCBBitmapConverterRotationNormal

    Rotated 0

    SCBBitmapConverterRotationRight90

    Rotated 90

    SCBBitmapConverterRotationLeft90

    Rotated 270

    SCBBitmapConverterRotationRotate180

    Rotated 180

4.2.16. SCBBlackMarkType

added in version 1.6.0

Black mark detection constants

  • Declaration

    typedef NS_ENUM(NSInteger, SCBBlackMarkType) {
        SCBBlackMarkTypeInvalid,
        SCBBlackMarkTypeValid,
        SCBBlackMarkTypeValidWithDetection
    };
    
  • Constants

    Name

    Contents

    SCBBlackMarkTypeInvalid

    Black mark detection invalid

    SCBBlackMarkTypeValid

    Black mark detection valid

    SCBBlackMarkTypeValidWithDetection

    Black mark detection valid with detect at power on

4.2.17. SCBLabelType

added in version 1.17.0

Gap detection constants for die-cut label paper, etc

  • Declaration

    typedef NS_ENUM(NSInteger, SCBLabelType) {
        SCBLabelTypeInvalid,
        SCBLabelTypeValid,
        SCBLabelTypeValidWithDetection
    };
    
    • Constants

      Name

      Contents

      SCBLabelTypeInvalid

      Gap detection invalid

      SCBLabelTypeValid

      Gap detection valid

      SCBLabelTypeValidWithDetection

      Gap detection valid with detect at power on

4.2.18. SCBPrintableAreaType

added in version 1.9.0

Printable area constants

  • Declaration

    typedef NS_ENUM(NSInteger, SCBPrintableAreaType) {
        SCBPrintableAreaTypeStandard,
        SCBPrintableAreaTypeType1,
        SCBPrintableAreaTypeType2,
        SCBPrintableAreaTypeType3,
        SCBPrintableAreaTypeType4
    }
    
  • Constants

    Name

    Contents

    SCBPrintableAreaTypeStandard

    Standard type

    SCBPrintableAreaTypeType1

    Type1

    SCBPrintableAreaTypeType2

    Type2

    SCBPrintableAreaTypeType3

    Type3

    SCBPrintableAreaTypeType4

    Type4

4.2.19. SCBCjkUnifiedIdeographFont

added in version 1.13.0

Constants of CJK Unified Ideograph font in UTF-8

  • Declaration

    typedef NS_ENUM(NSInteger, SCBCjkUnifiedIdeographFont) {
        SCBCjkUnifiedIdeographFontJapanese = 1,
        SCBCjkUnifiedIdeographFontSimplifiedChinese = 2,
        SCBCjkUnifiedIdeographFontTraditionalChinese = 3,
        SCBCjkUnifiedIdeographFontHangul = 4
    };
    
  • Constants

    Name

    Contents

    SCBCjkUnifiedIdeographFontJapanese

    Japanese font

    SCBCjkUnifiedIdeographFontSimplifiedChinese

    Simplified Chinese font

    SCBCjkUnifiedIdeographFontTraditionalChinese

    Traditional Chinese font

    SCBCjkUnifiedIdeographFontHangul

    Hangul font

4.2.20. SCBHoldPrintType

added in version 1.15.0

Constants to specify the hold print control

  • Declaration

    typedef NS_ENUM(NSInteger, SCBHoldPrintType) {
        SCBHoldPrintTypeInvalid = 1,
        SCBHoldPrintTypeValid = 2,
        SCBHoldPrintTypeDefault = 3,
    };
    
  • Constants

    Name

    Contents

    SCBHoldPrintTypeInvalid

    Invalid

    SCBHoldPrintTypeValid

    Valid

    SCBHoldPrintTypeDefault

    Follow the memory switch setting

4.2.21. SCBPaperPresentStatusType

added in version 1.15.0

Hold print status constants

  • Declaration

    typedef NS_ENUM(NSInteger, SCBPaperPresentStatusType) {
        SCBPaperPresentStatusTypeInvalid = 1,
        SCBPaperPresentStatusTypeValid = 2,
        SCBPaperPresentStatusTypeDefault = 3,
    };
    
  • Constants

    Name

    Contents

    SCBPaperPresentStatusTypeInvalid

    Invalid

    SCBPaperPresentStatusTypeValid

    Valid

    SCBPaperPresentStatusTypeDefault

    Follow the memory switch setting

4.2.22. commands

Gets the command buffer.

  • Declaration

    @property (nonatomic, readonly) NSMutableData *commands;
    
  • Parameter

    None

  • Return value

    Contents

    Type

    Command buffer

    NSMutableData *

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherData = [@"Hello World.\n" dataUsingEncoding:NSASCIIStringEncoding];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendData:otherData];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m.

4.2.23. beginDocument

Begin document command is generated and added to the command buffer.

  • Declaration

    - (void)beginDocument;
    
  • Parameter

    None

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherData = [@"Hello World.\n" dataUsingEncoding:NSASCIIStringEncoding];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendData:otherData];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m.

4.2.24. endDocument

End document command is generated and added to the command buffer.

  • Declaration

    - (void)endDocument;
    
  • Parameter

    None

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherData = [@"Hello World.\n" dataUsingEncoding:NSASCIIStringEncoding];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendData:otherData];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m.

4.2.25. appendInitialization

Initialization command is generated and added to the command buffer.

  • Declaration

    - (void)appendInitialization:(SCBInitializationType)type;
    
  • Parameter

    Name

    Contents

    Type

    type

    Initialization type

    SCBInitializationType

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherData = [@"Hello World.\n" dataUsingEncoding:NSASCIIStringEncoding];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendUnderLine:YES];
        [builder appendMultiple:2 height:2];
        [builder appendData:otherData];
    
        [builder appendInitialization:SCBInitializationTypeCommand];
    
        [builder appendData:otherData];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m.

4.2.26. appendData

Data (Text and Command) is added to the command buffer.

  • Declaration

    - (void)appendByte:(unsigned char)data;
    - (void)appendData:(NSData *)otherData;
    - (void)appendBytes:(const void *)bytes length:(NSUInteger)length;
    
  • Parameter

    Name

    Contents

    Type

    data
    otherData
    bytes

    Data (Text and Command)

    unsigned char
    NSData *
    const void *

    length

    Data length

    NSUInteger

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherData = [@"Hello World." dataUsingEncoding:NSASCIIStringEncoding];
    
        unsigned char bytes[] = {0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x57, 0x6f, 0x72, 0x6c, 0x64, 0x2e};
        NSUInteger length = sizeof(bytes);
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendData:otherData];
        [builder appendByte:'\n'];
    
        [builder appendBytes:bytes length:length];
        [builder appendByte:'\n'];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m and each Command Specifications.

4.2.27. appendRawData

Raw data (Text and Command) is added to the command buffer.

  • Declaration

    - (void)appendRawByte:(unsigned char)data;
    - (void)appendRawData:(NSData *)otherData;
    - (void)appendRawBytes:(const void *)bytes length:(NSUInteger)length;
    
  • Parameter

    Name

    Contents

    Type

    data
    otherData
    bytes

    Raw data (Text and Command)

    unsigned char
    NSData *
    const void *

    length

    Data length

    NSUInteger

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation image:(UIImage *)image {
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendBitmap:image diffusion:NO];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

4.2.28. appendFontStyle

Select command of the font style is generated and added to the command buffer.

  • Declaration

    - (void)appendFontStyle:(SCBFontStyleType)type;
    
  • Parameter

    Name

    Contents

    Type

    type

    Font style

    SCBFontStyleType

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherData = [@"Hello World.\n" dataUsingEncoding:NSASCIIStringEncoding];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendFontStyle:SCBFontStyleTypeA];
        [builder appendData:otherData];
    
        [builder appendFontStyle:SCBFontStyleTypeB];
        [builder appendData:otherData];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m and each Command Specifications.

4.2.29. appendCodePage

Select command of the code page is generated and added to the command buffer.

  • Declaration

    - (void)appendCodePage:(SCBCodePageType)type;
    
  • Parameter

    Name

    Contents

    Type

    type

    Code Page

    SCBCodePageType

  • Return value

    None

  • Examples

    + (NSData *)createCodePageData:(StarIoExtEmulation)emulation {
        unsigned char bytes8[] = {0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87, 0x88, 0x89, 0x8a, 0x8b, 0x8c, 0x8d, 0x8e, 0x8f, 0x0a};
        unsigned char bytes9[] = {0x90, 0x91, 0x92, 0x93, 0x94, 0x95, 0x96, 0x97, 0x98, 0x99, 0x9a, 0x9b, 0x9c, 0x9d, 0x9e, 0x9f, 0x0a};
        unsigned char bytesA[] = {0xa0, 0xa1, 0xa2, 0xa3, 0xa4, 0xa5, 0xa6, 0xa7, 0xa8, 0xa9, 0xaa, 0xab, 0xac, 0xad, 0xae, 0xaf, 0x0a};
        unsigned char bytesB[] = {0xb0, 0xb1, 0xb2, 0xb3, 0xb4, 0xb5, 0xb6, 0xb7, 0xb8, 0xb9, 0xba, 0xbb, 0xbc, 0xbd, 0xbe, 0xbf, 0x0a};
        unsigned char bytesC[] = {0xc0, 0xc1, 0xc2, 0xc3, 0xc4, 0xc5, 0xc6, 0xc7, 0xc8, 0xc9, 0xca, 0xcb, 0xcc, 0xcd, 0xce, 0xcf, 0x0a};
        unsigned char bytesD[] = {0xd0, 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8, 0xd9, 0xda, 0xdb, 0xdc, 0xdd, 0xde, 0xdf, 0x0a};
        unsigned char bytesE[] = {0xe0, 0xe1, 0xe2, 0xe3, 0xe4, 0xe5, 0xe6, 0xe7, 0xe8, 0xe9, 0xea, 0xeb, 0xec, 0xed, 0xee, 0xef, 0x0a};
        unsigned char bytesF[] = {0xf0, 0xf1, 0xf2, 0xf3, 0xf4, 0xf5, 0xf6, 0xf7, 0xf8, 0xf9, 0xfa, 0xfb, 0xfc, 0xfd, 0xfe, 0xff, 0x0a};
    
        NSUInteger length = sizeof(bytes2);
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendCodePage:SCBCodePageTypeCP932];
    
        [builder appendBytes:bytes8 length:length];
        [builder appendBytes:bytes9 length:length];
        [builder appendBytes:bytesA length:length];
        [builder appendBytes:bytesB length:length];
        [builder appendBytes:bytesC length:length];
        [builder appendBytes:bytesD length:length];
        [builder appendBytes:bytesE length:length];
        [builder appendBytes:bytesF length:length];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m and each Command Specifications.

4.2.30. appendInternational

Select command of the international character mode is generated and added to the command buffer.

  • Declaration

    - (void)appendInternational:(SCBInternationalType)type;
    
  • Parameter

    Name

    Contents

    Type

    type

    International character

    SCBInternationalType

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        unsigned char bytes[] = {0x23, 0x24, 0x40, 0x58, 0x5a, 0x5b, 0x5c, 0x5d, 0x5e, 0x60, 0x7b, 0x7c, 0x7d, 0x7e, 0x0a};
        NSUInteger length = sizeof(bytes);
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendInternational:SCBInternationalTypeUSA];
        [builder appendBytes:bytes length:length];
    
        [builder appendInternational:SCBInternationalTypeJapan];
        [builder appendBytes:bytes length:length];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m and each Command Specifications.

4.2.31. appendLineFeed

Line feed command is generated and added to the command buffer.

  • Declaration

    - (void)appendLineFeed;
    - (void)appendDataWithLineFeed:(NSData *)otherData;
    - (void)appendBytesWithLineFeed:(const void *)bytes length:(NSUInteger)length;
    - (void)appendLineFeed:(NSInteger)line;
    - (void)appendDataWithLineFeed:(NSData *)otherData line:(NSInteger)line;
    - (void)appendBytesWithLineFeed:(const void *)bytes length:(NSUInteger)length line:(NSInteger)line;
    
  • Parameter

    Name

    Contents

    Type

    line

    Paper feed units. (Units : Lines)

    NSInteger

    otherData
    bytes

    Data (Text and Command)

    NSData *
    const void *

    length

    Data length

    NSUInteger

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherData = [@"Hello World." dataUsingEncoding:NSASCIIStringEncoding];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendData:otherData];
        [builder appendLineFeed];
    
        [builder appendDataWithLineFeed:otherData];
    
        [builder appendData:otherData];
        [builder appendLineFeed:2];
    
        [builder appendDataWithLineFeed:otherData line:2];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m.

4.2.32. appendUnitFeed

Unit feed command is generated and added to the command buffer.

  • Declaration

    - (void)appendUnitFeed:(NSInteger)unit;
    - (void)appendDataWithUnitFeed:(NSData *)otherData unit:(NSInteger)unit;
    - (void)appendBytesWithUnitFeed:(const void *)bytes length:(NSUInteger)length unit:(NSInteger)unit;
    
  • Parameter

    Name

    Contents

    Type

    unit

    Paper feed units. (Units : Dots)

    NSInteger

    otherData
    bytes

    Data (Text and Command)

    NSData *
    const void *

    length

    Data length

    NSUInteger

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherData = [@"Hello World." dataUsingEncoding:NSASCIIStringEncoding];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendData:otherData];
        [builder appendUnitFeed:64];
    
        [builder appendDataWithUnitFeed:otherData unit:64];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m.

4.2.33. appendCharacterSpace

Set command of the character space is generated and added to the command buffer.

  • Declaration

    - (void)appendCharacterSpace:(NSInteger)space;
    
  • Parameter

    Name

    Contents

    Type

    space

    Character spaces. (Units : Dots)

    NSInteger

  • Return value

    None

Important

In Japanese, Simplified Chinese, Traditional Chinese, and Korean (DBCS), the character space is to be twice.

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherData = [@"Hello World.\n" dataUsingEncoding:NSASCIIStringEncoding];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendCharacterSpace:0];
        [builder appendData:otherData];
        [builder appendCharacterSpace:4];
        [builder appendData:otherData];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m.

4.2.34. appendLineSpace

Set command of the line space is generated and added to the command buffer.

  • Declaration

    - (void)appendLineSpace:(NSInteger)lineSpace;
    
  • Parameter

    Name

    Contents

    Type

    lineSpace

    Line spaces. (Units : Dots)

    NSInteger

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherData = [@"Hello World.\n" dataUsingEncoding:NSASCIIStringEncoding];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendLineSpace:32];
        [builder appendData:otherData];
        [builder appendData:otherData];
        [builder appendData:otherData];
    
        [builder appendLineSpace:24];
        [builder appendData:otherData];
        [builder appendData:otherData];
        [builder appendData:otherData];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m and each Command Specifications.

4.2.35. appendTopMargin

added in version 1.9.0

Set command of the top margin is generated and added to the command buffer.

  • Declaration

    - (void)appendTopMargin:(NSInteger)margin;
    
  • Parameter

    Name

    Contents

    Type

    margin

    Top margin. (Units : Millimeter)

    NSInteger

  • Return value

    None

  • Examples

    + (NSData *)createTopMarginData:(StarIoExtEmulation)emulation {
        NSData *data = [@"Hello, World.\n" dataUsingEncoding:NSASCIIStringEncoding];
    
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:StarIoExtEmulationStarPRNT];
    
        [builder beginDocument];
    
        [builder appendTopMargin:2];
        [builder appendData:[@"*Top margin:2mm*\n" dataUsingEncoding:NSASCIIStringEncoding]]; [builder appendData:data];
        [builder appendData:data];
        [builder appendData:data];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder appendTopMargin:6];
        [builder appendData:[@"*Top margin:6mm*\n" dataUsingEncoding:NSASCIIStringEncoding]]; [builder appendData:data];
        [builder appendData:data];
        [builder appendData:data];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder appendTopMargin:11];
        [builder appendData:[@"*Top margin:11mm*\n" dataUsingEncoding:NSASCIIStringEncoding]]; [builder appendData:data];
        [builder appendData:data];
        [builder appendData:data];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return builder.commands;
    }
    

    Refer to ApiFunctions.m.

4.2.36. appendEmphasis

Select command of the emphasis mode is generated and added to the command buffer.

  • Declaration

    - (void)appendEmphasis:(BOOL)emphasis;
    - (void)appendDataWithEmphasis:(NSData *)otherData;
    - (void)appendBytesWithEmphasis:(const void *)bytes length:(NSUInteger)length;
    
  • Parameter

    Name

    Contents

    Type

    emphasis

    Emphasis
    YES … Valid
    NO … Invalid

    BOOL

    otherData
    bytes

    Data (Text and Command)

    NSData *
    const void *

    length

    Data length

    NSUInteger

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherData = [@"Hello World.\n" dataUsingEncoding:NSASCIIStringEncoding];
        NSData *otherDataHalf0 = [@"Hello " dataUsingEncoding:NSASCIIStringEncoding];
        NSData *otherDataHalf1 = [@"World.\n" dataUsingEncoding:NSASCIIStringEncoding];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendData:otherData];
        [builder appendEmphasis:YES];
        [builder appendData:otherData];
        [builder appendData:otherData];
        [builder appendEmphasis:NO];
        [builder appendData:otherData];
    
        [builder appendDataWithEmphasis:otherData];
        [builder appendData:otherData];
    
        [builder appendDataWithEmphasis:otherDataHalf0];
        [builder appendData:otherDataHalf1];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m.

4.2.37. appendInvert

Select command of the invert mode is generated and added to the command buffer.

  • Declaration

    - (void)appendInvert:(BOOL)invert;
    - (void)appendDataWithInvert:(NSData *)otherData;
    - (void)appendBytesWithInvert:(const void *)bytes length:(NSUInteger)length;
    
  • Parameter

    Name

    Contents

    Type

    invert

    Invert
    YES … Valid
    NO … Invalid

    BOOL

    otherData
    bytes

    Data (Text and Command)

    NSData *
    const void *

    length

    Data length

    NSUInteger

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherData = [@"Hello World.\n" dataUsingEncoding:NSASCIIStringEncoding];
        NSData *otherDataHalf0 = [@"Hello " dataUsingEncoding:NSASCIIStringEncoding];
        NSData *otherDataHalf1 = [@"World.\n" dataUsingEncoding:NSASCIIStringEncoding];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendData:otherData];
        [builder appendInvert:YES];
        [builder appendData:otherData];
        [builder appendData:otherData];
        [builder appendInvert:NO];
        [builder appendData:otherData];
    
        [builder appendDataWithInvert:otherData];
        [builder appendData:otherData];
    
        [builder appendDataWithInvert:otherDataHalf0];
        [builder appendData:otherDataHalf1];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m.

4.2.38. appendMultiple

Select command of the multiple mode is generated and added to the command buffer.

  • Declaration

    - (void)appendMultiple:(NSInteger)width height:(NSInteger)height;
    - (void)appendDataWithMultiple:(NSData *)otherData width:(NSInteger)width height:(NSInteger)height;
    - (void)appendBytesWithMultiple:(const void *)bytes length:(NSUInteger)length width:(NSInteger)width height:(NSInteger)height;
    - (void)appendMultipleHeight:(NSInteger)height;
    - (void)appendDataWithMultipleHeight:(NSData *)otherData height:(NSInteger)height;
    - (void)appendBytesWithMultipleHeight:(const void *)bytes length:(NSUInteger)length height:(NSInteger)height;
    - (void)appendMultipleWidth:(NSInteger)width;
    - (void)appendDataWithMultipleWidth:(NSData *)otherData width:(NSInteger)width;
    - (void)appendBytesWithMultipleWidth:(const void *)bytes length:(NSUInteger)length width:(NSInteger)width;
    
  • Parameter

    Name

    Contents

    Type

    width

    Expanded width

    NSInteger

    height

    Expanded height

    NSInteger

    otherData
    bytes

    Data (Text and Command)

    NSData *
    const void *

    length

    Data length

    NSUInteger

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherData = [@"Hello World.\n" dataUsingEncoding:NSASCIIStringEncoding];
        NSData *otherDataHalf0 = [@"Hello " dataUsingEncoding:NSASCIIStringEncoding];
        NSData *otherDataHalf1 = [@"World.\n" dataUsingEncoding:NSASCIIStringEncoding];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendData:otherData];
    
        [builder appendMultiple:2 height:2];
        [builder appendData:otherData];
        [builder appendData:otherData];
        [builder appendMultiple:1 height:1];
        [builder appendData:otherData];
    
        [builder appendDataWithMultiple:otherData width:2 height:2];
        [builder appendData: otherData];
    
        [builder appendDataWithMultiple:otherDataHalf0 width:2 height:2];
        [builder appendData: otherDataHalf1];
    
        [builder appendData:otherDataHalf0];
        [builder appendDataWithMultiple:otherDataHalf1 width:2 height:2];
    
        [builder appendMultipleHeight:2];
        [builder appendData:otherData];
        [builder appendData:otherData];
        [builder appendMultipleHeight:1];
        [builder appendData:otherData];
    
        [builder appendDataWithMultipleHeight:otherDataHalf0 height:2];
        [builder appendData:otherDataHalf1];
    
        [builder appendData:otherDataHalf0];
        [builder appendDataWithMultipleHeight:otherDataHalf1 height:2];
    
        [builder appendMultipleWidth:2];
        [builder appendData:otherData];
        [builder appendData:otherData];
        [builder appendMultipleWidth:1];
        [builder appendData:otherData];
    
        [builder appendDataWithMultipleWidth:otherDataHalf0 width:2];
        [builder appendData:otherDataHalf1];
        [builder appendData:otherDataHalf0];
        [builder appendDataWithMultipleWidth:otherDataHalf1 width:2];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m and each Command Specifications.

4.2.39. appendUnderLine

Select command of the underline mode is generated and added to the command buffer.

  • Declaration

    - (void)appendUnderLine:(BOOL)underLine;
    - (void)appendDataWithUnderLine:(NSData *)otherData;
    - (void)appendBytesWithUnderLine:(const void *)bytes length:(NSUInteger)length;
    
  • Parameter

    Name

    Contents

    Type

    underLine

    Under line
    YES … Valid
    NO … Invalid

    BOOL

    otherData
    bytes

    Data (Text and Command)

    NSData *
    const void *

    length

    Data length

    NSUInteger

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherData = [@"Hello World.\n" dataUsingEncoding:NSASCIIStringEncoding];
        NSData *otherDataHalf0 = [@"Hello " dataUsingEncoding:NSASCIIStringEncoding];
        NSData *otherDataHalf1 = [@"World.\n" dataUsingEncoding:NSASCIIStringEncoding];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation]; [builder beginDocument];
    
        [builder appendData:otherData];
    
        [builder appendUnderLine:YES];
        [builder appendData:otherData];
        [builder appendData:otherData];
        [builder appendUnderLine:NO];
        [builder appendData:otherData];
    
        [builder appendDataWithUnderLine:otherData];
        [builder appendData:otherData];
    
        [builder appendDataWithUnderLine:otherDataHalf0];
        [builder appendData:otherDataHalf1];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m.

4.2.41. appendAbsolutePosition

Absolute position command is generated and added to the command buffer.

  • Declaration

    - (void)appendAbsolutePosition:(NSInteger)position;
    - (void)appendDataWithAbsolutePosition:(NSData *)otherData position:(NSInteger)position;
    - (void)appendBytesWithAbsolutePosition:(const void *)bytes length:(NSUInteger)length position:(NSInteger)position;
    
  • Parameter

    Name

    Contents

    Type

    position

    Absolute position. (Units : Dots)

    NSInteger

    otherData
    bytes

    Data (Text and Command)

    NSData *
    const void *

    length

    Data length

    NSUInteger

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherData = [@"Hello World.\n" dataUsingEncoding:NSASCIIStringEncoding];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendData:otherData];
    
        [builder appendAbsolutePosition:40];
        [builder appendData:otherData];
        [builder appendData:otherData];
    
        [builder appendDataWithAbsolutePosition:otherData position:40];
        [builder appendData:otherData];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m.

4.2.42. appendAlignment

Alignment command is generated and added to the command buffer.

  • Declaration

    - (void)appendAlignment:(SCBAlignmentPosition)position;
    - (void)appendDataWithAlignment:(NSData *)otherData position:(SCBAlignmentPosition)position;
    - (void)appendBytesWithAlignment:(const void *)bytes length:(NSUInteger)length position:(SCBAlignmentPosition)position;
    
  • Parameter

    Name

    Contents

    Type

    position

    Alignment position

    SCBAlignmentPosition

    otherData
    bytes

    Data (Text and Command)

    NSData *
    const void *

    length

    Data length

    NSUInteger

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherData = [@"Hello World.\n" dataUsingEncoding:NSASCIIStringEncoding];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendData:otherData];
    
        [builder appendAlignment:SCBAlignmentPositionRight];
        [builder appendData:otherData];
        [builder appendData:otherData];
    
        [builder appendAlignment:SCBAlignmentPositionLeft];
        [builder appendData:otherData];
        [builder appendData:otherData];
    
        [builder appendDataWithAlignment:otherData position:SCBAlignmentPositionRight];
        [builder appendData:otherData];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m and each Command Specifications.

4.2.43. appendHorizontalTabPosition

added in version 1.8.0

Horizontal tab set/clear command is generated and added to the command buffer.

  • Declaration

    - (void)appendHorizontalTabPosition:(NSArray<NSNumber *> *)positions;
    
  • Parameter

    Name

    Contents

    Type

    positions

    Array of horizontal tab positions (Units: ANK character pitch)
    Specifying nil or empty array deletes all currently set horizontal tab positions.

    NSArray<NSNumber *> *

  • Return value

    None

  • Examples

    + (NSData *)createHorizontalTabPositionData:(StarIoExtEmulation)emulation {
        NSData *otherData1 = [@"QTY\tITEM\tTOTAL\n" dataUsingEncoding:NSASCIIStringEncoding];
        NSData *otherData2 = [@"1\tApple\t1.50\n" dataUsingEncoding:NSASCIIStringEncoding];
        NSData *otherData3 = [@"2\tOrange\t2.00\n" dataUsingEncoding:NSASCIIStringEncoding];
        NSData *otherData4 = [@"5\tBanana\t3.00\n" dataUsingEncoding:NSASCIIStringEncoding];
    
        NSArray<NSNumber *> *positions = @[@5, @27];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendHorizontalTabPosition:positions];
    
        [builder appendData:[@"*Tab Position:5, 27*\n" dataUsingEncoding:NSASCIIStringEncoding]];
    
        [builder appendData:otherData1];
        [builder appendData:otherData2];
        [builder appendData:otherData3];
        [builder appendData:otherData4];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m.

4.2.44. appendCutPaper

Paper cut command is generated and added to the command buffer.

  • Declaration

    - (void)appendCutPaper:(SCBCutPaperAction)action;
    
  • Parameter

    Name

    Contents

    Type

    action

    Paper cut

    SCBCutPaperAction

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherData = [@"Hello World.\n" dataUsingEncoding:NSASCIIStringEncoding];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendData:otherData];
        [builder appendData:otherData];
        [builder appendData:otherData];
        [builder appendData:otherData];
        [builder appendData:otherData];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m.

4.2.45. appendPeripheral

Cash drawer command is generated and added to the command buffer.

  • Declaration

    - (void)appendPeripheral:(SCBPeripheralChannel)channel;
    - (void)appendPeripheral:(SCBPeripheralChannel)channel time:(NSInteger)time;
    
  • Parameter

    Name

    Contents

    Type

    channel

    Cash drawer channel

    SCBPeripheralChannel

    time

    Drive time. (Units : mSec)
    * Peripheral channel1 only.

    NSInteger

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendPeripheral:SCBPeripheralChannelNo1];
        [builder appendPeripheral:SCBPeripheralChannelNo2];
        [builder appendPeripheral:SCBPeripheralChannelNo1 time:2000];
        [builder appendPeripheral:SCBPeripheralChannelNo2 time:2000];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m and each Command Specifications.

4.2.46. appendSound

Sound/Buzzer command is generated and added to the command buffer.

  • Declaration

    - (void)appendSound:(SCBSoundChannel)channel;
    - (void)appendSound:(SCBSoundChannel)channel repeat:(NSInteger)repeat;
    - (void)appendSound:(SCBSoundChannel)channel repeat:(NSInteger)repeat driveTime:(NSInteger) driveTime delayTime:(NSInteger)delayTime
    
  • Parameter

    Name

    Contents

    Type

    Library version

    channel

    Sound/Buzzer channel

    SCBSoundChannel

    1.3.0+
    repeat

    Repeat count

    NSInteger

    1.3.0+
    driveTime

    Drive time. (Units : mSec)

    NSInteger

    1.9.0+
    delayTime

    Delay time. (Units : mSec)

    NSInteger

    1.9.0+
  • Return value

    None

Warning

Do not use this method with anything other than the buzzer connected. It may not work properly, and the printer or the peripheral unit in use may cause damage.

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendSound:SCBSoundChannelNo1];
        [builder appendSound:SCBSoundChannelNo2];
        [builder appendSound:SCBSoundChannelNo1 repeat:3];
        [builder appendSound:SCBSoundChannelNo2 repeat:3];
        [builder appendSound:SCBSoundChannelNo1 repeat:1 driveTime:1000 delayTime:1000];
        [builder appendSound:SCBSoundChannelNo2 repeat:1 driveTime:1000 delayTime:1000];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m and each Command Specifications.

4.2.47. appendBarcodeData

Print command of the barcode is generated and added to the command buffer.

  • Declaration

    - (void)appendBarcodeData:(NSData *)otherData symbology:(SCBBarcodeSymbology)symbology width:(SCBBarcodeWidth)width height:(NSInteger)height hri:(BOOL)hri;
    - (void)appendBarcodeBytes:(const void *)bytes length:(NSUInteger)length symbology:(SCBBarcodeSymbology)symbology width:(SCBBarcodeWidth)width height:(NSInteger)height hri:(BOOL)hri;
    
  • Parameter

    Name

    Contents

    Type

    otherData
    bytes

    Barcode data

    NSData *
    const void *

    length

    Data length

    NSUInteger

    symbology

    Barcode symbology

    SCBBarcodeSymbology

    width

    Barcode width

    SCBBarcodeWidth

    height

    Barcode height. (Units : Dots)

    NSInteger

    hri

    Under-bar characters
    YES … Valid
    NO … Invalid

    BOOL

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherDataCode128 = [@"{B0123456789" dataUsingEncoding:NSASCIIStringEncoding];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendBarcodeData:otherDataCode128 symbology:SCBBarcodeSymbologyCode128 width:SCBBarcodeWidthMode1 height:40 hri:YES];
    
        [builder appendUnitFeed:32];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m and each Command Specifications.

4.2.48. appendBarcodeDataWithAbsolutePosition

Print command of the absolute position barcode is generated and added to the command buffer.

  • Declaration

    - (void)appendBarcodeDataWithAbsolutePosition:(NSData *)otherData symbology:(SCBBarcodeSymbology)symbology width:(SCBBarcodeWidth)width height:(NSInteger)height hri:(BOOL)hri position:(NSInteger)position;
    - (void)appendBarcodeBytesWithAbsolutePosition:(const void *)bytes length:(NSUInteger)length symbology:(SCBBarcodeSymbology)symbology width:(SCBBarcodeWidth)width height:(NSInteger)height hri:(BOOL)hri position:(NSInteger)position;
    
  • Parameter

    Name

    Contents

    Type

    position

    Absolute position. (Units : Dots)

    NSInteger

    otherData
    bytes

    Barcode data

    NSData *
    const void *

    length

    Data length

    NSUInteger

    symbology

    Barcode symbology

    SCBBarcodeSymbology

    width

    Barcode width

    SCBBarcodeWidth

    height

    Barcode height. (Units : Dots)

    NSInteger

    hri

    Under-bar characters
    YES … Valid
    NO … Invalid

    BOOL

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherDataCode128 = [@"{B0123456789" dataUsingEncoding:NSASCIIStringEncoding];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendBarcodeDataWithAbsolutePosition:otherDataCode128 symbology:SCBBarcodeSymbologyCode128 width:SCBBarcodeWidthMode1 height:40 hri:YES position:40];
    
        [builder appendUnitFeed:32];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m and each Command Specifications.

4.2.49. appendBarcodeDataWithAlignment

Print command of the alignment barcode is generated and added to the command buffer.

  • Declaration

    - (void)appendBarcodeDataWithAlignment:(NSData *)otherData symbology:(SCBBarcodeSymbology)symbology width:(SCBBarcodeWidth)width height:(NSInteger)height hri:(BOOL)hri position:(SCBAlignmentPosition)position;
    - (void)appendBarcodeBytesWithAlignment:(const void *)bytes length:(NSUInteger)length symbology:(SCBBarcodeSymbology)symbology width:(SCBBarcodeWidth)width height:(NSInteger)height hri:(BOOL)hri position:(SCBAlignmentPosition)position;
    
  • Parameter

    Name

    Contents

    Type

    position

    Alignment position

    SCBAlignmentPosition

    otherData
    bytes

    Barcode data

    NSData *
    const void *

    length

    Data length

    NSUInteger

    symbology

    Barcode symbology

    SCBBarcodeSymbology

    width

    Barcode width

    SCBBarcodeWidth

    height

    Barcode height. (Units : Dots)

    NSInteger

    hri

    Under-bar characters
    YES … Valid
    NO … Invalid

    BOOL

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherDataCode128 = [@"{B0123456789" dataUsingEncoding:NSASCIIStringEncoding];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendBarcodeDataWithAlignment:otherDataCode128 symbology:SCBBarcodeSymbologyCode128 width:SCBBarcodeWidthMode1 height:40 hri:YES position:SCBAlignmentPositionCenter];
        [builder appendUnitFeed:32];
    
        [builder appendBarcodeDataWithAlignment:otherDataCode128 symbology:SCBBarcodeSymbologyCode128 width:SCBBarcodeWidthMode1 height:40 hri:YES position:SCBAlignmentPositionRight];
        [builder appendUnitFeed:32];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m and each Command Specifications.

4.2.50. appendPdf417Data

Print command of the PDF417 is generated and added to the command buffer.

  • Declaration

    - (void)appendPdf417Data:(NSData *)otherData line:(NSInteger)line column:(NSInteger)column level:(SCBPdf417Level)level module:(NSInteger)module aspect:(NSInteger)aspect;
    - (void)appendPdf417Bytes:(const void *)bytes length:(NSUInteger)length line:(NSInteger)line column:(NSInteger)column level:(SCBPdf417Level)level module:(NSInteger)module aspect:(NSInteger)aspect;
    
  • Parameter

    Name

    Contents

    Type

    otherData
    bytes

    PDF417 data

    NSData *
    const void *

    length

    Data length

    NSUInteger

    line

    Number of lines

    NSInteger

    column

    Number of columns

    NSInteger

    level

    PDF417 ECC (security level)

    SCBPdf417Level

    module

    Module X direction size

    NSInteger

    aspect

    Module aspect ratio

    NSInteger

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherData = [@"Hello World." dataUsingEncoding:NSASCIIStringEncoding];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendPdf417Data:otherData line:0 column:1 level:SCBPdf417LevelECC0 module:2 aspect:2];
        [builder appendUnitFeed:32];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m and each Command Specifications.

4.2.51. appendPdf417DataWithAbsolutePosition

Print command of the absolute position PDF417 is generated and added to the command buffer.

  • Declaration

    - (void)appendPdf417DataWithAbsolutePosition:(NSData *)otherData line:(NSInteger)line column:(NSInteger)column level:(SCBPdf417Level)level module:(NSInteger)module aspect:(NSInteger)aspect position:(NSInteger)position;
    - (void)appendPdf417BytesWithAbsolutePosition:(const void *)bytes length:(NSUInteger)length line:(NSInteger)line column:(NSInteger)column level:(SCBPdf417Level)level module:(NSInteger)module aspect:(NSInteger)aspect position:(NSInteger)position;
    
  • Parameter

    Name

    Contents

    Type

    position

    Absolute position. (Units : Dots)

    NSInteger

    otherData
    bytes

    PDF417 data

    NSData *
    const void *

    length

    Data length

    NSUInteger

    line

    Number of lines

    NSInteger

    column

    Number of columns

    NSInteger

    level

    PDF417 ECC (security level)

    SCBPdf417Level

    module

    Module X direction size

    NSInteger

    aspect

    Module aspect ratio

    NSInteger

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherData = [@"Hello World." dataUsingEncoding:NSASCIIStringEncoding];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendPdf417DataWithAbsolutePosition:otherData line:0 column:1 level:SCBPdf417LevelECC0 module:2 aspect:2 position:40];
        [builder appendUnitFeed:32];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m and each Command Specifications.

4.2.52. appendPdf417DataWithAlignment

Print command of the alignment PDF417 is generated and added to the command buffer.

  • Declaration

    - (void)appendPdf417DataWithAlignment:(NSData *)otherData line:(NSInteger)line column:(NSInteger)column level:(SCBPdf417Level)level module:(NSInteger)module aspect:(NSInteger)aspect position:(SCBAlignmentPosition)position;
    - (void)appendPdf417BytesWithAlignment:(const void *)bytes length:(NSUInteger)length line:(NSInteger)line column:(NSInteger)column level:(SCBPdf417Level)level module:(NSInteger)module aspect:(NSInteger)aspect position:(SCBAlignmentPosition)position;
    
  • Parameter

    Name

    Contents

    Type

    position

    Alignment position

    SCBAlignmentPosition

    otherData
    bytes

    PDF417 data

    NSData *
    const void *

    length

    Data length

    NSUInteger

    line

    Number of lines

    NSInteger

    column

    Number of columns

    NSInteger

    level

    PDF417 ECC (security level)

    SCBPdf417Level

    module

    Module X direction size

    NSInteger

    aspect

    Module aspect ratio

    NSInteger

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherData = [@"Hello World." dataUsingEncoding:NSASCIIStringEncoding];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendPdf417DataWithAlignment:otherData line:0 column:1 level:SCBPdf417LevelECC0 module:2 aspect:2 position:SCBAlignmentPositionCenter];
        [builder appendUnitFeed:32];
    
        [builder appendPdf417DataWithAlignment:otherData line:0 column:1 level:SCBPdf417LevelECC0 module:2 aspect:2 position:SCBAlignmentPositionRight];
        [builder appendUnitFeed:32];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m and each Command Specifications.

4.2.53. appendQrCodeData

Print command of the QR code is generated and added to the command buffer.

  • Declaration

    - (void)appendQrCodeData:(NSData *)otherData model:(SCBQrCodeModel)model level:(SCBQrCodeLevel)level cell:(NSInteger)cell;
    - (void)appendQrCodeBytes:(const void *)bytes length:(NSUInteger)length model:(SCBQrCodeModel)model level:(SCBQrCodeLevel)level cell:(NSInteger)cell;
    
  • Parameter

    Name

    Contents

    Type

    otherData
    bytes

    QR code data

    NSData *
    const void *

    length

    Data length

    NSUInteger

    model

    QR code model

    SCBQrCodeModel

    level

    QR code mistake correction level

    SCBQrCodeLevel

    cell

    QR code cell size

    NSInteger

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherData = [@"Hello World." dataUsingEncoding:NSASCIIStringEncoding];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendQrCodeData:otherData model:SCBQrCodeModelNo2 level:SCBQrCodeLevelL cell:4];
        [builder appendUnitFeed:32];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m and each Command Specifications.

4.2.54. appendQrCodeDataWithAbsolutePosition

Print command of the absolute position QR code is generated and added to the command buffer.

  • Declaration

    - (void)appendQrCodeDataWithAbsolutePosition:(NSData *)otherData model:(SCBQrCodeModel)model level:(SCBQrCodeLevel)level cell:(NSInteger)cell position:(NSInteger)position;
    - (void)appendQrCodeBytesWithAbsolutePosition:(const void *)bytes length:(NSUInteger)length model:(SCBQrCodeModel)model level:(SCBQrCodeLevel)level cell:(NSInteger)cell position:(NSInteger)position;
    
  • Parameter

    Name

    Contents

    Type

    position

    Absolute position. (Units : Dots)

    NSInteger

    otherData
    bytes

    QR code data

    NSData *
    const void *

    length

    Data length

    NSUInteger

    model

    QR code model

    SCBQrCodeModel

    level

    QR code mistake correction level

    SCBQrCodeLevel

    cell

    QR code cell size

    NSInteger

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherData = [@"Hello World." dataUsingEncoding:NSASCIIStringEncoding];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendQrCodeDataWithAbsolutePosition:otherData model:SCBQrCodeModelNo2 level:SCBQrCodeLevelL cell:4 position:40];
        [builder appendUnitFeed:32];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m and each Command Specifications.

4.2.55. appendQrCodeDataWithAlignment

Print command of the alignment QR code is generated and added to the command buffer.

  • Declaration

    - (void)appendQrCodeDataWithAlignment:(NSData *)otherData model:(SCBQrCodeModel)model level:(SCBQrCodeLevel)level cell:(NSInteger)cell position:(SCBAlignmentPosition)position;
    - (void)appendQrCodeBytesWithAlignment:(const void *)bytes length:(NSUInteger)length model:(SCBQrCodeModel)model level:(SCBQrCodeLevel)level cell:(NSInteger)cell position:(SCBAlignmentPosition)position;
    
  • Parameter

    Name

    Contents

    Type

    position

    Alignment position

    SCBAlignmentPosition

    otherData
    bytes

    QR code data

    NSData *
    const void *

    length

    Data length

    NSUInteger

    model

    QR code model

    SCBQrCodeModel

    level

    QR code mistake correction level

    SCBQrCodeLevel

    cell

    QR code cell size

    NSInteger

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherData = [@"Hello World." dataUsingEncoding:NSASCIIStringEncoding];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendQrCodeDataWithAlignment:otherData model:SCBQrCodeModelNo2 level:SCBQrCodeLevelL cell:4 position:SCBAlignmentPositionCenter];
        [builder appendUnitFeed:32];
    
        [builder appendQrCodeDataWithAlignment:otherData model:SCBQrCodeModelNo2 level:SCBQrCodeLevelL cell:4 position:SCBAlignmentPositionRight];
        [builder appendUnitFeed:32];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m and each Command Specifications.

4.2.56. appendBitmap

Print command of the bitmap is generated and added to the command buffer.

  • Declaration

    - (void)appendBitmap:(UIImage *)image diffusion:(BOOL)diffusion width:(NSInteger)width bothScale:(BOOL)bothScale rotation:(SCBBitmapConverterRotation)rotation;
    - (void)appendBitmap:(UIImage *)image diffusion:(BOOL)diffusion rotation:(SCBBitmapConverterRotation)rotation;
    - (void)appendBitmap:(UIImage *)image diffusion:(BOOL)diffusion width:(NSInteger)width bothScale:(BOOL)bothScale;
    - (void)appendBitmap:(UIImage *)image diffusion:(BOOL)diffusion;
    
  • Parameter

    Name

    Contents

    Type

    bitmap

    Source bitmap object

    UIImage *

    diffusion

    Random dither
    YES … Valid
    NO … Invalid

    BOOL

    width

    Bitmap width after conversion. (Units : Dots)

    NSInteger

    bothScale

    Height is changed according to the conversion rate of the width property.
    YES … Valid
    NO … Invalid

    BOOL

    rotation

    Rotation.

    SCBBitmapConverterRotation

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation width:(NSInteger)width {
        UIImage *starLogoImage = [UIImage imageNamed:@"StarLogoImage"];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendData:[@"\n*Normal*\n" dataUsingEncoding:NSASCIIStringEncoding]];
        [builder appendBitmap:starLogoImage diffusion:YES];
    
        [builder appendData:[@"\n*width:Full, bothScale:YES*\n" dataUsingEncoding:NSASCIIStringEncoding]];
        [builder appendBitmap:starLogoImage diffusion:YES width:width bothScale:YES];
        [builder appendData:[@"\n*width:Full, bothScale:NO*\n" dataUsingEncoding:NSASCIIStringEncoding]];
        [builder appendBitmap:starLogoImage diffusion:YES width:width bothScale:NO];
    
        [builder appendData:[@"\n*Rotate180*\n" dataUsingEncoding:NSASCIIStringEncoding]];
        [builder appendBitmap:starLogoImage diffusion:YES rotation:SCBBitmapConverterRotationRotate180];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m.

4.2.57. appendBitmapWithAbsolutePosition

Print command of the absolute position bitmap is generated and added to the command buffer.

  • Declaration

    - (void)appendBitmapWithAbsolutePosition:(UIImage *)image diffusion:(BOOL)diffusion width:(NSInteger)width bothScale:(BOOL)bothScale rotation:(SCBBitmapConverterRotation)rotation position:(NSInteger)position;
    - (void)appendBitmapWithAbsolutePosition:(UIImage *)image diffusion:(BOOL)diffusion rotation:(SCBBitmapConverterRotation)rotation position:(NSInteger)position;
    - (void)appendBitmapWithAbsolutePosition:(UIImage *)image diffusion:(BOOL)diffusion width:(NSInteger)width bothScale:(BOOL)bothScale position:(NSInteger)position;
    - (void)appendBitmapWithAbsolutePosition:(UIImage *)image diffusion:(BOOL)diffusion position:(NSInteger)position;
    
  • Parameter

    Name

    Contents

    Type

    position

    Absolute position. (Units : Dots)

    NSInteger

    bitmap

    Source bitmap object

    UIImage *

    diffusion

    Random dither
    YES … Valid
    NO … Invalid

    BOOL

    width

    Bitmap width after conversion. (Units : Dots)

    NSInteger

    bothScale

    Height is changed according to the conversion rate of the width property.
    YES … Valid
    NO … Invalid

    BOOL

    rotation

    Rotation.

    SCBBitmapConverterRotation

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation width:(NSInteger)width {
        UIImage *starLogoImage = [UIImage imageNamed:@"StarLogoImage"];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendData:[@"\n*Normal, AbsolutePosition:40*\n" dataUsingEncoding:NSASCIIStringEncoding]];
        [builder appendBitmapWithAbsolutePosition:starLogoImage diffusion:YES position:40];
    
        [builder appendData:[@"\n*width:Full, bothScale:YES, AbsolutePosition:40*\n" dataUsingEncoding:NSASCIIStringEncoding]];
        [builder appendBitmap:starLogoImage diffusion:YES width:width bothScale:YES position:40];
        [builder appendData:[@"\n*width:Full, bothScale:NO, AbsolutePosition:40*\n" dataUsingEncoding:NSASCIIStringEncoding]];
        [builder appendBitmap:starLogoImage diffusion:YES width:width bothScale:NO position:40];
    
        [builder appendData:[@"\n*Rotate180, AbsolutePosition:40*\n" dataUsingEncoding:NSASCIIStringEncoding]];
        [builder appendBitmapWithAbsolutePosition:starLogoImage diffusion:YES rotation:SCBBitmapConverterRotationRotate180 position:40];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m.

4.2.58. appendBitmapWithAlignment

Print command of the alignment bitmap is generated and added to the command buffer.

  • Declaration

    - (void)appendBitmapWithAlignment:(UIImage *)image diffusion:(BOOL)diffusion width:(NSInteger)width bothScale:(BOOL)bothScale rotation:(SCBBitmapConverterRotation)rotation position:(SCBAlignmentPosition)position;
    - (void)appendBitmapWithAlignment:(UIImage *)image diffusion:(BOOL)diffusion rotation:(SCBBitmapConverterRotation)rotation position:(SCBAlignmentPosition)position;
    - (void)appendBitmapWithAlignment:(UIImage *)image diffusion:(BOOL)diffusion width:(NSInteger)width bothScale:(BOOL)bothScale position:(SCBAlignmentPosition)position;
    - (void)appendBitmapWithAlignment:(UIImage *)image diffusion:(BOOL)diffusion position:(SCBAlignmentPosition)position;
    
  • Parameter

    Name

    Contents

    Type

    position

    Alignment position

    SCBAlignmentPosition

    bitmap

    Source bitmap object

    UIImage *

    diffusion

    Random dither
    YES … Valid
    NO … Invalid

    BOOL

    width

    Bitmap width after conversion. (Units : Dots)

    NSInteger

    bothScale

    Height is changed according to the conversion rate of the width property.
    YES … Valid
    NO … Invalid

    BOOL

    rotation

    Rotation.

    SCBBitmapConverterRotation

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation width:(NSInteger)width {
        UIImage *starLogoImage = [UIImage imageNamed:@"StarLogoImage"];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendData:[@"\n*Normal, Alignment:Center*\n" dataUsingEncoding:NSASCIIStringEncoding]];
        [builder appendBitmapWithAlignment:starLogoImage diffusion:YES position:SCBAlignmentPositionCenter];
    
        [builder appendData:[@"\n*width:Full, bothScale:YES, Alignment:Center*\n" dataUsingEncoding:NSASCIIStringEncoding]];
        [builder appendBitmapWithAlignment:starLogoImage diffusion:YES width:width bothScale:YES position:SCBAlignmentPositionCenter];
        [builder appendData:[@"\n*width:Full, bothScale:NO, Alignment:Center*\n" dataUsingEncoding:NSASCIIStringEncoding]];
        [builder appendBitmapWithAlignment:starLogoImage diffusion:YES width:width bothScale:NO position:SCBAlignmentPositionCenter];
    
        [builder appendData:[@"\n*Rotate180, Alignment:Center*\n" dataUsingEncoding:NSASCIIStringEncoding]];
        [builder appendBitmapWithAlignment:starLogoImage diffusion:YES rotation:SCBBitmapConverterRotationRotate180 position:SCBAlignmentPositionCenter];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m.

4.2.59. appendBlackMark

added in version 1.6.0

Black mark detection command is generated and added to the command buffer.

  • Declaration

    - (void)appendBlackMark:(SCBBlackMarkType)type;
    
  • Parameter

    Name

    Contents

    Type

    type

    Black mark detection

    SCBBlackMarkType

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherData = [@"Hello World.\n" dataUsingEncoding:NSASCIIStringEncoding];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendBlackMark:SCBBlackMarkTypeValid];
    
        [builder appendData:otherData];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
    // [builder appendBlackMark:SCBBlackMarkTypeInvalid];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m.

4.2.60. appendLabel

added in version 1.17.0

Gap detection command for die-cut label paper, etc is generated and added to the command buffer.

  • Declaration

    - (void)appendLabelType:(SCBLabelType)type;
    
  • Parameter

    Name

    Contents

    Type

    type

    Cap detection

    SCBLabelType

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation {
        NSData *otherData = [@"Hello World.\n" dataUsingEncoding:NSASCIIStringEncoding];
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendLabel:SCBLabelTypeValid];
    
        [builder appendData:otherData];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
    // [builder appendLabel:SCBLabelTypeInvalid];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m.

4.2.61. beginPageMode

added in version 1.6.0

Begin page mode command is generated and added to the command buffer.

  • Declaration

    - (void)beginPageMode:(CGRect)rect rotation:(SCBBitmapConverterRotation)rotation;
    
  • Parameter

    Name

    Contents

    Type

    rect

    Location and size. (Units : Dots)

    CGRect

    rotation

    Print direction

    SCBBitmapConverterRotation

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation width:(NSInteger)width {
        NSData *otherData = [@"Hello World.\n" dataUsingEncoding:NSASCIIStringEncoding];
    
        int height = 30 * 8; // 30mm!!!
    
        CGRect rect;
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendData:[@"\n*Rotate180 Text*\n" dataUsingEncoding:NSASCIIStringEncoding]];
    
        rect = CGRectMake(0, 0, width, height);
    
        [builder beginPageMode:rect rotation:SCBBitmapConverterRotationRotate180];
    
        [builder appendPageModeVerticalAbsolutePosition:height / 2];
    
        [builder appendDataWithAbsolutePosition:otherData position:width / 2];
    
        [builder endPageMode];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m.

4.2.62. endPageMode

added in version 1.6.0

End page mode command is generated and added to the command buffer.

  • Declaration

    - (void)endPageMode;
    
  • Parameter

    None

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation width:(NSInteger)width {
        NSData *otherData = [@"Hello World.\n" dataUsingEncoding:NSASCIIStringEncoding];
    
        int height = 30 * 8; // 30mm!!!
    
        CGRect rect;
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendData:[@"\n*Rotate180 Text*\n" dataUsingEncoding:NSASCIIStringEncoding]];
    
        rect = CGRectMake(0, 0, width, height);
    
        [builder beginPageMode:rect rotation:SCBBitmapConverterRotationRotate180];
    
        [builder appendPageModeVerticalAbsolutePosition:height / 2];
    
        [builder appendDataWithAbsolutePosition:otherData position:width / 2];
    
        [builder endPageMode];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m.

4.2.63. appendPageModeVerticalAbsolutePosition

added in version 1.6.0

Vertical absolute position in page mode command is generated and added to the command buffer.

  • Declaration

    - (void)appendPageModeVerticalAbsolutePosition:(NSInteger)position;
    
  • Parameter

    Name

    Contents

    Type

    position

    Vertical absolute position in page mode. (Units : Dots)

    NSInteger

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation width:(NSInteger)width {
        NSData *otherData = [@"Hello World.\n" dataUsingEncoding:NSASCIIStringEncoding];
    
        int height = 30 * 8; // 30mm!!!
    
        CGRect rect;
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendData:[@"\n*Rotate180 Text*\n" dataUsingEncoding:NSASCIIStringEncoding]];
    
        rect = CGRectMake(0, 0, width, height);
    
        [builder beginPageMode:rect rotation:SCBBitmapConverterRotationRotate180];
    
        [builder appendPageModeVerticalAbsolutePosition:height / 2];
    
        [builder appendDataWithAbsolutePosition:otherData position:width / 2];
    
        [builder endPageMode];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m.

4.2.64. appendPageModeRotation

added in version 1.6.0

Print direction in page mode command is generated and added to the command buffer.

  • Declaration

    - (void)appendPageModeRotation:(SCBBitmapConverterRotation)rotation;
    
  • Parameter

    Name

    Contents

    Type

    rotation

    Print direction

    SCBBitmapConverterRotation

  • Return value

    None

  • Examples

    + (NSData *)createData:(StarIoExtEmulation)emulation width:(NSInteger)width {
        NSData *otherData = [@"Hello World.\n" dataUsingEncoding:NSASCIIStringEncoding];
    
        int height = 30 * 8; // 30mm!!!
    
        CGRect rect;
    
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendData:[@"\n*Mixed Text*\n" dataUsingEncoding:NSASCIIStringEncoding]];
    
        rect = CGRectMake(0, 0, width, height);
    
        [builder beginPageMode:rect rotation:SCBBitmapConverterRotationNormal];
    
        [builder appendPageModeVerticalAbsolutePosition:height / 2];
    
        [builder appendDataWithAbsolutePosition:otherData position:width / 2];
    
        [builder appendPageModeRotation:SCBBitmapConverterRotationRotate180];
    
        [builder appendPageModeVerticalAbsolutePosition:height / 2];
    
        [builder appendDataWithAbsolutePosition:otherData position:width / 2];
    
        [builder endPageMode];
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return [builder.commands copy];
    }
    

    Refer to ApiFunctions.m.

4.2.65. appendPrintableArea

added in version 1.9.0

Set command of the printable area is generated and added to the command buffer.

  • Declaration

    - (void)appendPrintableArea:(SCBPrintableAreaType)type;
    
  • Parameter

    Name

    Contents

    Type

    type

    Printable area

    SCBPrintableAreaType

  • Return value

    None

Unit:mm

The relationship between the specified PrintableAreaType and the print area to be set is the following.

Model/Emulation

mC-Print2 mC-Print3 mC-Label3 mPOP FVP10 TSP100IV TSP100IV SK TSP100IIIW TSP100IIIBITSP100IIIU TSP100ECO TSP100U TSP100GTTSP100LAN TSP650II TSP650IISK TSP700II TSP800IISM-S210i SM-S220i SM-S230i SM-T300i/T300 SM-T400i BSC10 SM-L200 SM-L300 SP700
StarPRNT StarPRNT StarPRNT StarPRNT StarLine StarPRNT StarPRNT StarGraphic StarGraphic StarGraphic StarGraphic StarGraphic StarGraphic StarGraphic StarLine StarLine StarLine StarLine StarPRNT EscPosMobile StarPRNT EscPosMobile StarPRNT EscPosMobile StarPRNT EscPosMobile StarPRNT EscPosMobile EscPos StarPRNT StarPRNT StarDotImpact

SCBPrintableAreaTypeStandard

48 72[1] 72[1] 48 72[1] 72[1] 72[1] 72[1] 72[1] 72[1] 72[1] 72[1] 72[1] 72[1] 72[1] 72[1] 72[1] 104[2] - - - - - - - - - - 64[1][3] - 72[1] 63

SCBPrintableAreaTypeType1

54 - 54 54 52.5 51 51 51 51 51 51 51 51 51 - 34.5 52.5 - - - - - - - - - - - - - - 48

SCBPrintableAreaTypeType2

- 48 48 - - 48 48 - - - - - - - - 32 80[1] 72 - - - - - - - - - - - - - 60

SCBPrintableAreaTypeType3

50.8 50.8 50.8 50.8 50.8 50.8 50.8 - - - - - - - 50.8 50.8 50.8 - - - - - - - - - - - 45[3] - 50.8 45

SCBPrintableAreaTypeType4

- - - - 52 - - - - - - - - - - - 52 - - - - - - - - - - - - - - 57
[1]

When 2-inch paper is used, do not set a print area with width 3 inches.

[2]

When 3-inch paper is used, do not set a print area with width 4 inches.

[3]

When “Maximum number of lines” is set for the number of memory switch print lines, 72 mm is set for Standard and 50.8 mm is set for Type 3. (Bit 4 of memory switch 4 is set to 1.)

  • Examples

    + (NSData *)createPrintableAreaDataWithEmulation:(StarIoExtEmulation)emulation type:(SCBPrintableAreaType)type {
        ISCBBuilder *builder = [StarIoExt createCommandBuilder:emulation];
    
        [builder beginDocument];
    
        [builder appendPrintableArea:type];
    
        switch (type) {
        case SCBPrintableAreaTypeStandard:
            [builder appendData:[@"*Standard*\n" dataUsingEncoding:NSASCIIStringEncoding]];
            break;
        case SCBPrintableAreaTypeType1:
            [builder appendData:[@"*Type1*\n" dataUsingEncoding:NSASCIIStringEncoding]];
            break;
        case SCBPrintableAreaTypeType2:
            [builder appendData:[@"*Type2*\n" dataUsingEncoding:NSASCIIStringEncoding]];
            break;
        case SCBPrintableAreaTypeType3:
            [builder appendData:[@"*Type3*\n" dataUsingEncoding:NSASCIIStringEncoding]];
            break;
        case SCBPrintableAreaTypeType4:
            [builder appendData:[@"*Type4*\n" dataUsingEncoding:NSASCIIStringEncoding]];
            break;
        }
    
        UIImage *image = [UIImage imageNamed:@"PrintableAreaImage.png"];
        [builder appendBitmap:image diffusion:true];
    
        NSData *data1 = [@"123456789" dataUsingEncoding:NSASCIIStringEncoding];
        NSData *data2 = [@"0" dataUsingEncoding:NSASCIIStringEncoding];
    
        for (int i = 0; i < 8; i++) {
        [builder appendData:data1];
        [builder appendDataWithInvert:data2];
        }
    
        [builder appendCutPaper:SCBCutPaperActionPartialCutWithFeed];
    
        [builder endDocument];
    
        return builder.commands;
    }
    

    Refer to ApiFunctions.m.

4.2.66. appendCjkUnifiedIdeographFont

added in version 1.13.0

A command to set the UTF-8 CJK Unified Ideograph font is generated and added to the command buffer.

  • Declaration

    - (void)appendCjkUnifiedIdeographFont:(NSArray<NSNumber *> *)fonts;
    
  • Parameter

    Name

    Contents

    Type

    font

    CJK Unified Ideograph font in UTF-8
    When two or more fonts are specified, the font specified earlier is printed first.
    If nothing is specified for the argument, the font setting of the CJK Unified Ideograph is returned to the memory switch setting.

    SCBCjkUnifiedIdeographFont

  • Return value

    None

  • Examples

    - (void)append3inchTextReceiptData:(ISCBBuilder *)builder utf8:(BOOL)utf8 {
        NSStringEncoding encoding = NSUTF8StringEncoding;
    
        // This function is supported by TSP650II(JP2/TW models only) with F/W version 4.0 or later and mC-Print 2/3.
        // Switch Kanji/Hangul font by specifying the font for Unicode CJK Unified Ideographs before each word.
    
        [builder appendCodePage:SCBCodePageTypeUTF8];
    
        [builder appendCharacterSpace:0];
    
        [builder appendAlignment:SCBAlignmentPositionCenter];
    
        [builder appendData:[@"2017 / 5 / 15 AM 10:00\n" dataUsingEncoding:encoding]];
    
        [builder appendMultiple:2 height:2];
    
        [builder appendCjkUnifiedIdeographFont:@[@(SCBCjkUnifiedIdeographFontJapanese)]];
        [builder appendData:[@"受付票 " dataUsingEncoding:encoding]];
    
        [builder appendCjkUnifiedIdeographFont:@[@(SCBCjkUnifiedIdeographFontTraditionalChinese)]];
        [builder appendData:[@"排號單\n" dataUsingEncoding:encoding]];
    
        [builder appendCjkUnifiedIdeographFont:@[@(SCBCjkUnifiedIdeographFontSimplifiedChinese)]];
        [builder appendData:[@"排号单 " dataUsingEncoding:encoding]];
    
        [builder appendCjkUnifiedIdeographFont:@[@(SCBCjkUnifiedIdeographFontHangul)]];
        [builder appendData:[@"접수표\n\n" dataUsingEncoding:encoding]];
    
        [builder appendMultiple:1 height:1];
    
        [builder appendCjkUnifiedIdeographFont:@[]];
        [builder appendDataWithMultiple:[@"1\n" dataUsingEncoding:encoding] width:6 height:6];
        [builder appendData:[@"------------------------------------------\n" dataUsingEncoding:encoding]];
    
        [builder appendCjkUnifiedIdeographFont:@[@(SCBCjkUnifiedIdeographFontJapanese)]];
        [builder appendData:[@"ご本人がお持ちください。\n" dataUsingEncoding:encoding]];
        [builder appendData:[@"※紛失しないようにご注意ください。\n" dataUsingEncoding:encoding]];
    }
    

    Refer to Utf8MultiLanguageReceiptsImpl.m.

4.2.67. appendHoldPrint

added in version 1.15.0

A command to specify the hold print control by the printer firmware is generated and added to the command buffer.

  • Declaration

    - (void)appendHoldPrint:(SCBHoldPrintType)type;
    
  • Parameter

    Name

    Contents

    Type

    type

    Hold print control

    SCBHoldPrintType

  • Return value

    None

Note

To enable the hold print control

The following settings enable the control of awaiting paper removal ( beginCheckedBlock method is blocked until paper is removed). See also the Example on next page.

  1. Disable the hold print control by the printer firmware using the command generated by this method.

  2. Enable hold print status using the command generated by the appendPaperPresentStatus method.

4.2.68. appendPaperPresentStatus

added in version 1.15.0

A command to specify hold print status is generated and added to the command buffer.

  • Declaration

    - (void)appendPaperPresentStatus:(SCBPaperPresentStatusType)type;
    
  • Parameter

    Name

    Contents

    Type

    type

    Hold print status

    SCBPaperPresentStatusType

  • Return value

    None