Select your printer model
getPrinterSetting
Acquires the set value of the printer setting.
The value acquired by this API is notified to the listener method specified in the listener parameter.
Syntax
public void getPrinterSetting(int timeout, int type, PrinterSettingListener listener) throws Epos2Exception |
Parameter
timeout
Specifies the timeout period before completion of printing in milliseconds.
Value |
Description |
---|---|
Integer from 5000 to 600000 |
Timeout period (in milliseconds) |
Printer.PARAM_DEFAULT |
Specifies the default value (10000). |
type
Specifies the printer setting item to be acquired.
Value |
Description |
---|---|
Printer.Setting.PaperWidth |
Paper width |
Printer.Setting.PrintDensity |
Print density |
Printer.Setting.PrintSpeed |
Print speed |
listener
Registers the listener method that returns the processing result of this API.
- (void) onGetPrinterSetting(int code, int type, int value); |
- code
The processing result is stored. -
Error status
Description
CODE_SUCCESS
Processed successfully.
CODE_ERR_AUTORECOVER
Automatic recovery error occurred.
CODE_ERR_COVER_OPEN
Cover open error occurred.
CODE_ERR_CUTTER
Auto cutter error occurred.
CODE_ERR_MECHANICAL
Mechanical error occurred.
CODE_ERR_EMPTY
No paper is left in the roll paper end detector.
CODE_ERR_PARAM
An invalid parameter was passed.
CODE_ERR_MEMORY
Memory necessary for processing could not be allocated.
CODE_ERR_TIMEOUT
Failed to communicate with the devices within the specified time.
CODE_ERR_PROCESSING
Could not run the process.
CODE_ERR_ILLEGAL
This API was called while no communication had been started.
CODE_ERR_FAILURE
An unknown error occurred.
- type
The acquired printer setting item is stored. -
Value
Description
Printer.Setting.PaperWidth
Paper width
Printer.Setting.PrintDensity
Print density
Printer.Setting.PrintSpeed
Print speed
- value
The acquired set value of the printer setting is stored. -
Value
Description
Printer.Setting.PaperWidth58_0
Paper width 58 mm
Printer.Setting.PaperWidth60_0
Paper width 60 mm
Printer.Setting.PaperWidth70_0
Paper width 70 mm
Printer.Setting.PaperWidth76_0
Paper width 76 mm
Printer.Setting.PaperWidth80_0
Paper width 80 mm
Printer.Setting.PrintDensityDIP
Print density DIP switch setting
Printer.Setting.PrintDensity70
Print density 70%
Printer.Setting.PrintDensity75
Print density 75%
Printer.Setting.PrintDensity80
Print density 80%
Printer.Setting.PrintDensity85
Print density 85%
Printer.Setting.PrintDensity90
Print density 90%
Printer.Setting.PrintDensity95
Print density 95%
Printer.Setting.PrintDensity100
Print density 100%
Printer.Setting.PrintDensity105
Print density 105%
Printer.Setting.PrintDensity110
Print density 110%
Printer.Setting.PrintDensity115
Print density 115%
Printer.Setting.PrintDensity120
Print density 120%
Printer.Setting.PrintDensity125
Print density 125%
Printer.Setting.PrintDensity130
Print density 130%
Printer.Setting.PrintSpeed1
Print speed level 1
Printer.Setting.PrintSpeed2
Print speed level 2
Printer.Setting.PrintSpeed3
Print speed level 3
Printer.Setting.PrintSpeed4
Print speed level 4
Printer.Setting.PrintSpeed5
Print speed level 5
Printer.Setting.PrintSpeed6
Print speed level 6
Printer.Setting.PrintSpeed7
Print speed level 7
Printer.Setting.PrintSpeed8
Print speed level 8
Printer.Setting.PrintSpeed9
Print speed level 9
Printer.Setting.PrintSpeed10
Print speed level 10
Printer.Setting.PrintSpeed11
Print speed level 11
Printer.Setting.PrintSpeed12
Print speed level 12
Printer.Setting.PrintSpeed13
Print speed level 13
Printer.Setting.PrintSpeed14
Print speed level 14
Printer.Setting.PrintSpeed15
Print speed level 15
Printer.Setting.PrintSpeed16
Print speed level 16
Printer.Setting.PrintSpeed17
Print speed level 17
Exception
When the process fails, Epos2Exception with one of the following error status occurs.
Error status |
Description |
---|---|
ERR_PARAM |
An invalid parameter was passed. |
ERR_FAILURE |
An unknown error occurred. |
Supplementary explanation
- This API is not executed on the main thread. Execute it on the sub-thread.
- This API cannot be used simultaneously with other APIs.
After executing this API, do not execute any other API until the callback is returned. - Do not turn off the power supply to the printer while executing this API.
- This API can be used in the system configuration of the TM printer model and customer
display model.
With the system configuration of the TM Printer + DM-D + barcode scanner model, this API can be used when connecting via Bluetooth or USB. - This API cannot be used with SSL/TLS communication.
Quick Access
- [Name]
- [Format]
- [Range]
- [Description]
- [Notes]
- Introduction
- help
- Printer class
- Printer
- 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
- setStatusChangeEventListener
- setReceiveEventListener
- setGetPrinterSettingExListener
- setSetPrinterSettingExListener
- setVerifyPasswordListener
- interval
- LFCPrinter class
- HybridPrinter class
- HybridPrinter
- connect
- disconnect
- startMonitor
- stopMonitor
- getStatus
- sendData
- beginTransaction
- endTransaction
- clearCommandBuffer
- selectPaperType
- waitInsertion
- cancelInsertion
- ejectPaper
- readMicrData
- cleanMicrReader
- forceRecover
- forcePulse
- forceCommand
- forceReset
- paperType
- interval
- waitTime
- mode40Cpl
- setStatusChangeEventListener
- setReceiveEventListener
- LineDisplay class
- LineDisplay
- 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
- setReceiveEventListener
- Keyboard class
- POSKeyboard class
- BarcodeScanner class
- MSR class
- SimpleSerial class
- GermanyFiscalElement class
- OtherPeripheral class
- CommBox class
- Common to all classes
- Discovery class
- Epos2Exception class
- Log class
- EasySelect class
- EasySelectInfo class
- 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-T20IV-L
- TM-T20X
- TM-T20X-II
- TM-T60
- TM-T70
- TM-T70II
- TM-T81II
- TM-T81III
- TM-T82
- TM-T82II
- TM-T82III
- TM-T82IIIL
- TM-T82IV-L
- TM-T82X
- TM-T82X-II
- TM-T83II
- TM-T83III
- TM-T83IV
- TM-T88V
- TM-T88VI
- TM-T88VII
- TM-T100
- TM-L90 Liner-Free Label Printer Model
- TM-L100
- TM-U220
- TM-U330
- EU-m30
- 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-T70II-DT
- TM-T70II-DT2
- TM-T88V-DT
- TM-T88VI-DT2
- TM-H6000IV-DT
- TM-T88IV
- TM-T90
- TM-L90
- TM-H6000IV