addCreateScreen

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

This API is used to call the layout setting of the base window having customer display.

Syntax

	- (int) addCreateScreen: (int) mode;

Parameter

mode

Specifies the combination of the display area of the base window and the screen configuration (text/image).

Value	Installation method	Area (columns × rows)	Screen configuration
EPOS2_LAYOUT_MODE_1	Landscape orientation	20 x 2	“Horizontal split” Divided equally into top and bottom portions. Top: Text, Bottom: Image
EPOS2_LAYOUT_MODE_2	Landscape orientation	20 x 2	“Horizontal split” Divided equally into top and bottom portions. Top: Image, Bottom: Text
EPOS2_LAYOUT_MODE_3	Landscape orientation	20 x 2	“Display in center” Only text is displayed at the center. No division.
EPOS2_LAYOUT_MODE_4	Landscape orientation	32 x 4	“Horizontal split” Divided equally into top and bottom portions. Top: Text, Bottom: Image
EPOS2_LAYOUT_MODE_5	Landscape orientation	32 x 4	“Horizontal split” Divided equally into top and bottom portions. Top: Image, Bottom: Text
EPOS2_LAYOUT_MODE_6	Landscape orientation	32 x 4	“Display in center” Only text is displayed at the center. No division.
EPOS2_LAYOUT_MODE_7	Landscape orientation	42 x 8	“Horizontal split” Divided equally into top and bottom portions. Top: Text, Bottom: Image
EPOS2_LAYOUT_MODE_8	Landscape orientation	42 x 8	“Horizontal split” Divided equally into top and bottom portions. Top: Image, Bottom: Text
EPOS2_LAYOUT_MODE_9	Landscape orientation	42 x 8	“Display in center” Only text is displayed at the center. No division.
EPOS2_LAYOUT_MODE_10	Landscape orientation	32 x 3	“Horizontal split” Divided equally into top and bottom portions. Top: Text, Bottom: Image
EPOS2_LAYOUT_MODE_11	Landscape orientation	32 x 3	“Horizontal split” Divided equally into top and bottom portions. Top: Image, Bottom: Text
EPOS2_LAYOUT_MODE_12	Landscape orientation	32 x 3	“Display in center” Only text is displayed at the center. No division.
EPOS2_LAYOUT_MODE_13	Landscape orientation	32 x 2	“Horizontal split” Divided equally into top and bottom portions. Top: Text, Bottom: Image
EPOS2_LAYOUT_MODE_14	Landscape orientation	32 x 2	“Horizontal split” Divided equally into top and bottom portions. Top: Image, Bottom: Text
EPOS2_LAYOUT_MODE_15	Landscape orientation	32 x 2	“Display in center” Only text is displayed at the center. No division.

Return value

Error status	Description
EPOS2_SUCCESS	The function was executed successfully.
EPOS2_ERR_PARAM	An invalid parameter was specified.
EPOS2_ERR_MEMORY	Sufficient memory required for processing could not be allocated.
EPOS2_ERR_FAILURE	An unknown error occurred.

Supplementary explanation

If this API is executed, all items displayed in customer display are erased.

Quick Access

[Name]
[Format]
[Range]
[Description]
[Notes]

Epson ePOS SDK includes patented or patent pending functions. The contents must not be disclosed to third parties.

Epson ePOS SDK for iOS

Introduction
help
Epos2Printer class
- initWithPrinterSeries
- connect
- disconnect
- startMonitor
- stopMonitor
- getStatus
- sendData
- beginTransaction
- endTransaction
- requestPrintJobStatus
- clearCommandBuffer
- addTextAlign
- addLineSpace
- addTextRotate
- addText
- addTextLang
- addTextFont
- addTextSmooth
- addTextSize
- addTextStyle
- addHPosition
- addFeedUnit
- addFeedLine
- addImage
- addLogo
- addBarcode
- addSymbol
- addHLine
- addVLineBegin
- addVLineEnd
- addPageBegin
- addPageEnd
- addPageArea
- addPageDirection
- addPagePosition
- addPageLine
- addPageRectangle
- addRotateBegin
- addRotateEnd
- addCut
- addPulse
- addSound
- addFeedPosition
- addLayout
- addCommand
- getMaintenanceCounter
- resetMaintenanceCounter
- getPrinterSetting
- setPrinterSetting
- getPrinterSettingEx
- setPrinterSettingEx
- setPrinterSettingEx[Obsolete]
- verifyPassword
- getPrinterInformation
- downloadFirmwareList
- getPrinterFirmwareInfo
- verifyUpdate
- updateFirmware
- forceRecover
- forcePulse
- forceStopSound
- forceCommand
- forceReset
- setStatusChangeEventDelegate
- setReceiveEventDelegate
- setGetPrinterSettingExDelegate
- setSetPrinterSettingExDelegate
- setVerifyPasswordDelegate
- interval
Epos2LFCPrinter class
- initWithPrinterSeries
- connect
- disconnect
- startMonitor
- stopMonitor
- getStatus
- sendLFCData
- setLFCStatusChangeEventDelegate
- setSendCompleteEventDelegate
- setPrintCompleteEventDelegate
Epos2HybridPrinter class
- initWithLang
- connect
- disconnect
- startMonitor
- stopMonitor
- getStatus
- sendData
- beginTransaction
- endTransaction
- clearCommandBuffer
- selectPaperType
- waitInsertion
- cancelInsertion
- ejectPaper
- readMicrData
- cleanMicrReader
- forceRecover
- forcePulse
- forceCommand
- forceReset
- paperType
- interval
- waitTime
- mode40Cpl
- setStatusChangeEventDelegate
- setReceiveEventDelegate
Epos2LineDisplay class
- initWithDisplayModel
- connect
- disconnect
- getStatus
- sendData
- clearCommandBuffer
- addInitialize
- addCreateWindow
- addDestroyWindow
- addSetCurrentWindow
- addClearCurrentWindow
- addCreateScreen
- addCreateScreenCustom
- addCreateTextArea
- addDestroyTextArea
- addSetCurrentTextArea
- addClearCurrentTextArea
- addSetCursorPosition
- addMoveCursorPosition
- addSetCursorType
- addText
- addReverseText
- addMarqueeText
- addSetBlink
- addSetBrightness
- addBackgroundColor
- addStartSlideShow
- addStopSlideShow
- addDownloadImage
- addRegisterDownloadImage
- addNVImage
- addClearImage
- addSymbol
- addClearSymbol
- addShowClock
- addCommand
- setReceiveEventDelegate
Epos2Keyboard class
- init
- connect
- disconnect
- getStatus
- setPrefix
- getPrefix
- setKeyPressEventDelegate
- setReadStringEventDelegate
Epos2POSKeyboard class
- init
- connect
- disconnect
- getStatus
- setKeyPressEventDelegate
Epos2BarcodeScanner class
- init
- connect
- disconnect
- getStatus
- setScanEventDelegate
Epos2MSR class
- init
- connect
- disconnect
- getStatus
- setDataEventDelegate
Epos2SimpleSerial class
- init
- connect
- disconnect
- getStatus
- sendCommand
- setReceiveEventDelegate
Epos2GermanyFiscalElement class
- init
- connect
- disconnect
- getStatus
- operate
- setReceiveEventDelegate
Epos2OtherPeripheral class
- init
- connect
- disconnect
- getStatus
- sendData
- setReceiveEventDelegate
Epos2CommBox class
- init
- connect
- disconnect
- getStatus
- getCommHistory
- sendMessage
- setReceiveEventDelegate
Common to all classes
- getAdmin
- getLocation
- setConnectionEventDelegate
Epos2Discovery class
- start
- stop
Epos2Log class
- setLogSettings
- SdkVersion
Epos2BluetoothConnection class
- connectDevice
- disconnectDevice
EasySelect class
- parseNFC
- parseQR
- createQR
- parseBeacon
EasySelectInfo class
- deviceType
- printerName
- macAddress
- target
Appendix
- Status list
- Key code list
- List of Supported Classes
- List of Supported APIs
- Printer-specific Support Information
  - TM-m10
  - TM-m30
  - TM-m30II
  - TM-m30II-H
  - TM-m30II-NT
  - TM-m30II-S
  - TM-m30II-SL
  - TM-m30III
  - TM-m30III-H
  - TM-m50
  - TM-m50II
  - TM-m50II-H
  - TM-T20
  - TM-T20II
  - TM-T20III
  - TM-T20IIIL
  - TM-T20X
  - TM-T60
  - TM-T70
  - TM-T70II
  - TM-T81II
  - TM-T81III
  - TM-T82
  - TM-T82II
  - TM-T82III
  - TM-T82IIIL
  - TM-T82X
  - TM-T83III
  - TM-T88V
  - TM-T88VI
  - TM-T88VII
  - TM-T100
  - TM-L90 Liner-Free Label Printer Model
  - TM-L100
  - TM-U220
  - TM-U220II
  - TM-U330
  - TM-P20
  - TM-P20II
  - TM-P60 (Receipt)
  - TM-P60 (Peeler)
  - TM-P60II (Receipt)
  - TM-P60II (Peeler)
  - TM-P80
  - TM-P80II
  - TM-H6000V
  - TM-T20II-i
  - TM-T70-i
  - TM-T82II-i
  - TM-T83II-i
  - TM-T88V-i
  - TM-T88VI-iHUB
  - TM-U220-i
  - TM-U220IIB-i
  - TM-T70II-DT
  - TM-T70II-DT2
  - TM-T88V-DT
  - TM-T88VI-DT2
  - TM-H6000IV-DT
  - TM-T88IV
  - TM-T90
  - TM-L90
  - TM-H6000IV
- Usage restriction by firmware version