opos1.13apdevguide en rev1.00
TRANSCRIPT
-
7/26/2019 Opos1.13apdevguide en Rev1.00
1/74
CITIZEN OPOS DRIVER 1.13Application Development Guide
Feb. 10, 2011 Rev1.0
http://www.citizen-systems.co.jp/http://www.citizen-systems.co.jp/ -
7/26/2019 Opos1.13apdevguide en Rev1.00
2/74
2
CITIZEN OPOS DRIVER 1.13 Application Development Guide
Revision Record
Date Revision Description
Feb. 10, 2011 Rev1.00 New issue
-
7/26/2019 Opos1.13apdevguide en Rev1.00
3/74
3
CITIZEN OPOS DRIVER 1.13 Application Development Guide
Notes
1. Unauthorized use of all or any part of this document is prohibited.
2. The information in this document is subject to change without prior notice.
3. This document has been created with full attention. If, however, you find an error or question,
please contact us.
4. We shall not be liable for any effect resulting from operation regardless of the above item 3.
5. If you do not agree with the above terms, you are not permitted to use this driver.
Trademark
Microsoft, Windows, Windows Vista, Visual Studio, Visual Basic, and Visual C++ are registered
trademarks of Microsoft Corporation in the United States and/or other countries. (Official name
for Windows is Microsoft Windows Operating System.)
Company names and product names appearing on this document are trademarks and/or registered
trademarks of respective companies.
CITIZEN is a registered trademark of Citizen Holdings Co., Ltd.
-
7/26/2019 Opos1.13apdevguide en Rev1.00
4/74
4
CITIZEN OPOS DRIVER 1.13 Application Development Guide
Contents
1. Introduction................................................................................................................................... 6
1.1. CITIZEN OPOS Driver ..................................................................................................................... 61.2. Operating Environment ................................................................................................................... 6
1.3. Application Developer ..................................................................................................................... 7
1.4. OPOS Control................................................................................................................................. 71.5. CITIZEN OPOS Driver Registry Structure .......................................................................................... 8
Registry Operation ........................................................................................................................................9
1.6. CITIZEN OPOS Driver Precautions.................................................................................................... 9
2. CITIZEN OPOS Printer Service Object ......................................................................................... 11
2.1. POS Printer Service Object and Method Relations ............................................................................ 11
CT-S281........................................................................................................................................................11
CT-S310........................................................................................................................................................12
CT-S2000......................................................................................................................................................13
CT-S601/651/801/851...................................................................................................................................14
CT-S4000......................................................................................................................................................15CD-S500 .......................................................................................................................................................16
2.2. POS Printer Service Object and Property Relations........................................................................... 17
CT-S281........................................................................................................................................................17
CT-S310........................................................................................................................................................22
CT-S2000......................................................................................................................................................27
CT-S601/651/801/851...................................................................................................................................32
CT-S4000......................................................................................................................................................37
CD-S500 .......................................................................................................................................................42
2.3. POS Printer Service Object and OPOS Escape Sequence Relations .................................................... 46
CT-S281........................................................................................................................................................46
CT-S310........................................................................................................................................................47
CT-S2000......................................................................................................................................................48
CT-S601/651/801/851...................................................................................................................................49
CT-S4000......................................................................................................................................................50
CD-S500 .......................................................................................................................................................51
2.4. POS Printer Service Object and Event Relations............................................................................... 52
CT-S281........................................................................................................................................................52
CT-S310........................................................................................................................................................52
CT-S2000......................................................................................................................................................52
CT-S601/651/801/851...................................................................................................................................52
CT-S4000......................................................................................................................................................53
CD-S500 .......................................................................................................................................................53
2.5. POS Printer Service Object and Precautions .................................................................................... 54
ClaimDevice Method ...................................................................................................................................54
PrintBarCode Method.................................................................................................................................54
RotatePrint Method.....................................................................................................................................55
SetBitmap Method/ESC|#B Escape Sequence..........................................................................................55
PrintBitmap Method / PrintMemoryBitmap Method ...............................................................................57
AsyncMode Property ...................................................................................................................................58
ErrorLevel Property ....................................................................................................................................58
BinaryConversion Property ........................................................................................................................58
OutPutID Property/ OutputCompleteEvent Event...................................................................................60
RecLineChars/ RecLineCharsList Property ..............................................................................................61
RecSidewaysMaxChars Property ...............................................................................................................62
RecSidewaysMaxLines Property ................................................................................................................62
ResultCode/ ResultCodeExtended Property ..............................................................................................63
Status Update Event...................................................................................................................................63
3. Cash Drawer Service Object......................................................................................................... 64
3.1. Cash Drawer Service and Object Method Relations .......................................................................... 64
-
7/26/2019 Opos1.13apdevguide en Rev1.00
5/74
5
CITIZEN OPOS DRIVER 1.13 Application Development Guide
CT-S310........................................................................................................................................................64
CT-S2000......................................................................................................................................................64
CT-S601/651/801/851...................................................................................................................................65
CT-S4000......................................................................................................................................................65
CD-S500 .......................................................................................................................................................65
3.2. Cash Drawer Service Object and Property Relations......................................................................... 66
CT-S310........................................................................................................................................................66
CT-S2000......................................................................................................................................................67
CT-S601/651/801/851...................................................................................................................................68
CT-S4000......................................................................................................................................................70
CD-S500 .......................................................................................................................................................71
3.3. Cash Drawer Service Object and Event Relations............................................................................. 72CT-S310........................................................................................................................................................72
CT-S2000......................................................................................................................................................72
CT-S601/651/801/851...................................................................................................................................72
CT-S4000......................................................................................................................................................72
CD-S500 .......................................................................................................................................................72
3.4. Cash Drawer Service Object and Precautions .................................................................................. 73
CapPowerReporting/ Powermotify/ PowerState Property........................................................................73
CapStatusMultiDrawerDetect Property....................................................................................................73
-
7/26/2019 Opos1.13apdevguide en Rev1.00
6/74
6
CITIZEN OPOS DRIVER 1.13 Application Development Guide
1. Introduction
The OPOS Driver complies with OPOS1.13. This document provides the explanation of device(POS printer)-dependent specifications and precautions. When you want to develop applicationsby using this driver, refer to OpenPOS for OLE Application Programmers Guide, Japanese Edition,Version 1.13 beforehand.Reference link (as of Jan. 18, 2011)https://www.microsoft.com/japan/business/industry/retail/opos/download.mspx
1.1. CITIZEN OPOS Driver
This driver provides an open device driver architecture that can easily integrate the CITIZEN POSprinter and the cash drawer connected to it by the POS system based on Microsoft WindowsOperating System. This driver has been developed for the following purpose.- Definition of architecture for accessing the Win32-based POS printer and cash drawer connected
to it
- Definition of interface of CITIZEN POS printer supporting POS solution and cash drawerconnected to it
1.2. Operating Environment
Object Operating SystemThis driver supports the following Windows operating systems.
- Windows Xp- Windows Vista- Windows 7
From Windows Vista/7, operating system's registory structure is modified. Some applications
that was programmed for Windows XP may not work correctly.
Object ModelsObject models of this driver and the corresponding drivers are as shown below.For details of each model, refer to the Printer Users Guide.
Object Model FunctionApplicable driver
(Printer)Applicable driver
(Drawer)
CT-S281 Standard CT-S281_* Not supported
CT-S310 Standard (Paper with blackmark on frontside is supported)
CT-S310-M1/M2 Paper with blackmark on back side is
supported.
CT-S310_* CT-S310_*.CD*
CT-S2000 Standard
CT-S2000-M Blackmark paper is supported.
CT-S2000-L Label paper is supported.
CT-S2000_* CT-S2000_*.CD*
CT-S601/651/801/851 Standard
CT-S801/851-M Blackmark paper is supported.
CT-S801-L Label paper is supported.
CT-S601_*CT-S651_*CT-S801_*CT-S851_*
CT-S601_*.CD*CT-S651_*.CD*CT-S801_*.CD*CT-S851_*.CD*
CT-S4000 Standard (Paper with blackmark on frontside is supported)
CT-S4000-M Paper with blackmark on back side issupported.
CT-S4000-L Label paper is supported.
CT-S4000_* CT-S4000_*.CD*
CD-S500 Standard type (Without cutting feature)
CD-S501 With cutting feature
CD-S503 Rewinder equipped (With cutting feature)
CD-S500_* CD-S500_*.CD*
https://www.microsoft.com/japan/business/industry/retail/opos/download.mspxhttps://www.microsoft.com/japan/business/industry/retail/opos/download.mspx -
7/26/2019 Opos1.13apdevguide en Rev1.00
7/74
7
CITIZEN OPOS DRIVER 1.13 Application Development Guide
1.3. Application Developer
Application developer who wants to use this driver must be familiar with the following items.- OPOS1.13 specifications- General characteristics of CITIZEN POS printer
- Terms and structure of ActiveX control and OLE automation- ActiveX control container development environment such as Microsoft Visual Basic and MicrosoftVisual C++, etc.
1.4. OPOS Control
The OPOS control, conforming to ActiveX control specifications, provides the application withproperty, method, and/or event. It consists of control object (CO) for device class and serviceobject (SO). CO supplies application interface (API) and SO executes the API,The OPOS software us implemented by the use of the layer shown in the following figure.
Device ClassThis is a category of the POS device sharing the set of property, method and event.
Control Object (CO)Control Object provides the application with a set of property, method and event for each deviceclass. CO is a standard Active (OLE 32 bit) control and is not visible at the time of execution.As a rule, this driver uses OPOS standard CO. (OPOS standard CO is installed automatically atthe installation of this driver.)
Service Object (SO)Service Object is called by Control Object and executes the function specified by OPOS for eachdevice. It is implemented as automation server and provides the set of methods called by CO.This driver provides the processing dependent on the CITIZEN POS printer and cash drawerconnected to the printer.
OPOS
ontrol
SystemRegistration
MappingParameter
Application
Control ObjectDevice class supportDevice independent
Service Object
Device dependent
Operating System/Driver
Interface
ActiveX
Control
Interface
ActiveX
Automation
MethodProperty
Method
EventMethod
Printer
Event
Cash Drawer
-
7/26/2019 Opos1.13apdevguide en Rev1.00
8/74
8
CITIZEN OPOS DRIVER 1.13 Application Development Guide
1.5. CITIZEN OPOS Driver Registry Structure
In order for Control Object to be connected to Service Object exactly and initialize thecorresponding device, the OPOS control requires data for the system registry. The registry hasa hierarchical structure with levels called key. Each key consists of the following.
- Additional key (also called sub-key)- Named value (Data of string, binary, or double-word type is defined for each value.)- One default value defined by string-type data.
OPOS defines only string data.
The following is a registry structure taking CT-S2000 (printer and cash drawer) as an example.
Wi ndows Regi st r y Edi t or Versi on 5. 00
[ HKEY_LOCAL_MACHI NE\ SOFTWARE\ OLEf orRet ai l \ Ser vi ceOPOS\ POSPr i nter \ CT- S2000_1]@="CBM. Ther mal . POSPri nt er ""Physi cal Devi ceI D"="CI TI ZENCT- S2000""Versi on"="1008009""Wr i t eTi meout "="5000"
"Pi n3"="001""St atusBackI nt erval "="200""Ser vi ce"="C: \ \ Pr ogr am Fi l es\ \ CI TI ZEN\ \ CI TI ZEN Ser vi ce Obj ects\ \ CSJ TSO. dl l ""Por t "="NET: ""BaudRat e"="57600""HandShake"="000""Bi t Length"="008""Par i t y"="000""Fami l yI D"="001""MapResol ut i on"="000""Pr i nterName"="CTS2000. CI TI ZEN. POSPr i nter""Devi ceDescr i pt i on"="Ci t i zen Syst ems Thermal POSPri nt er. ""Servi ceObj ect Descri pt i on"="Ci t i zen Syst ems Servi ce Obj ect f or Thermal PosPri nt ers ver1. 13. xx. "
"Pr i nterMode"="000""Bi t mapMode"="000""Pr i nterLanguageModel "="008""PaperSensor"="000""Paper Model "="002""Col umn"="001""UseNVRAM"="001""Char acterSet "="932"" I P_Addr "="192. 168. 0. 1""Port No"="9100"
[ HKEY_LOCAL_MACHI NE\ SOFTWARE\ OLEf or Ret ai l \ Servi ceOPOS\ CashDr awer \ CT- S2000_1. CD1]@="CBM. Ther mal . CashDr awer ""Physi cal Devi ceI D"="CI TI ZENCT- S2000""Versi on"="1008009"
"Wr i t eTi meout "="5000""Pi n3"="000""St atusBackI nt erval "="200""Ser vi ce"="C: \ \ Pr ogr am Fi l es\ \ CI TI ZEN\ \ CI TI ZEN Ser vi ce Obj ects\ \ CSJ TSO. dl l ""Por t "="NET: ""BaudRat e"="57600""HandShake"="000""Bi t Length"="008""Par i t y"="000""Servi ceObj ect Descri pt i on"="Ci t i zen Syst ems Ser vi ce Obj ect f or CT- S2000_1 Pr i nt er CashDr awer No. 1 ver 1. 13. xx"
"Dr awer Name"="CTS2000. CI TI ZEN. CD1""Devi ceDescr i pt i on"="Ci t i zen Syst ems Thermal POSPr i nter ' s Cash Dr awer 1""OnTi me"="005""Pri nt erI D"="CT- S2000_1""CapStat us"="001"" I P_Addr "="192. 168. 0. 1""Por t No"="9100"
-
7/26/2019 Opos1.13apdevguide en Rev1.00
9/74
9
CITIZEN OPOS DRIVER 1.13 Application Development Guide
Registry Operation
Writing illegal value in a registry may cause serious trouble in the system. Therefore, Closeattention is required in handling a registry. When handling a registry, the following registry-setting tool (Configuration Utility) shall be used as a rule. For the method of using this tool,refer to Setup Guide of this driver.
(Configuration Utility)
1.6. CITIZEN OPOS Driver Precautions
In case of printer with USB interface, bidirectional communication which is registers to theWindows must be cancelled.
If you are using Windows XP, click "Start" button on the task bar and "Printers and Faxes".Printers registered to Windows are shown in the opened window. Right-click the printer to be
used by OPOS and click "Printer Properties" to show dialog described lator.
If you are using WIndows Vista or Windows 7, click "Start" button on the task bar and"Devices and Printers". Printers registered to Windows are shown in the opened window.Right-click the printer to be used by OPOS and click "Printer Properties" to show dialogdescribed lator.
Unchkeck "Enable bidirectional support" checkbutton in the "Ports" tab and click OK button.The following figure is a case of CT-S310 on Windows XP. In this figure, the "Enablebidirectional support" checkbox is indexed by red arrow, and unchecked.
-
7/26/2019 Opos1.13apdevguide en Rev1.00
10/74
10
CITIZEN OPOS DRIVER 1.13 Application Development Guide
When printing on label paper, use MarkFeed method (handling of marked paper).
For the method of using this method, refer to OpenPOS for OLE Application Programmer'sGuide Japanese Version Rev. 1.13.
Please note that proper operation is n guaranteed at the environment where OPOS driver byother company is installed.
Also refer to the notes in each chapter.ot
-
7/26/2019 Opos1.13apdevguide en Rev1.00
11/74
11
CITIZEN OPOS DRIVER 1.13 Application Development Guide
2. CITIZEN OPOS Printer Service Object
For the details, method of use, etc. of property, method and event, refer to OpenPOS for OLEApplication Programmer's Guide, Japanese Edition, Version 1.13.
2.1. POS Printer Service Object and Method Relations
CT-S281
Method NotesStatus of support by the driver
(CT-S281_*)
Open
Close
ClaimDevice
Notes on Serial I/F connection(Refer to ClaimDevice in 2.5.POSPrinter Service Object andPrecautions.)
ReleaseDevice
CheckHealthOPOS_CH_EXTERNALOnly (self diagnostic printing) issupported.
OPOS_CH_EXTERNAL
ClearInput Not applicable with OPOSPrinter Not applied because no input device is used.
ClearOutputData being transmitted cannot bestopped.
CompareFirmwareVersion Not supported
DirectIO Not supported
ResetStatistics Not supported (OPOS_E_ILLEGAL)
RetrieveStatistics Not supported (OPOS_E_ILLEGAL)
UpdateFirmware Not supported
UpdateStatistics Not supported (OPOS_E_ILLEGAL)
PrintNormal PrintTwoNormal Not supported
PrintImmediate
BeginInsertion Not supported
EndInsertion Not supported
BeginRemoval Not supported
EndRemoval Not supported
CutPaper Partial cut (1-99)Full cut (0, 100)
RotatePrint (Refer to RotatePrint in 2.5.POS Printer Service Object andPrecautions.)
PrintBarCode (Refer to PrintBarcode in 2.5.POS
Printer Service Object andPrecautions.)
PrintBitmap Raster bit image printing
TransactionPrint
ValidateData
SetBitmap (Refer to SetBitmap Method/ESC|#BEscape Sequence in 2.5.POS Printer Service Object andPrecautions.)
Raster bit image modeNV bit image mode
SetLogo
ChangePrintSide Not supported (OPOS_E_ILLEGAL)
MarkFeed
ClearPrintArea
PageModePrint
PrintMemoryBitmap
DrawRuledLine Not supported
-
7/26/2019 Opos1.13apdevguide en Rev1.00
12/74
12
CITIZEN OPOS DRIVER 1.13 Application Development Guide
CT-S310
Method NotesStatus of support by the driver
(CT-S310_*)
Open
Close
ClaimDevice
Notes on Serial I/F connection(Refer to ClaimDevice in 2.5.POSPrinter Service Object andPrecautions.)
ReleaseDevice
CheckHealthOPOS_CH_EXTERNALOnly (self diagnostic printing) issupported.
OPOS_CH_EXTERNAL
ClearInput Not applicable with OPOSPrinter Not applied because no input device is used.
ClearOutputData being transmitted cannot bestopped.
CompareFirmwareVersion Not supported
DirectIO Not supported
ResetStatistics Not supported (OPOS_E_ILLEGAL)RetrieveStatistics Not supported (OPOS_E_ILLEGAL)
UpdateFirmware Not supported
UpdateStatistics Not supported (OPOS_E_ILLEGAL)
PrintNormal
PrintTwoNormal Not supported
PrintImmediate
BeginInsertion Not supported
EndInsertion Not supported
BeginRemoval Not supported
EndRemoval Not supported
CutPaper Partial cut (1-99)Full cut (0, 100)
RotatePrint (Refer to RotatePrint in 2.5.POS Printer Service Object andPrecautions.)
PrintBarCode (Refer to PrintBarcode in 2.5.POSPrinter Service Object andPrecautions.)
PrintBitmap Raster bit image printing
TransactionPrint
ValidateData
SetBitmap (Refer to SetBitmap Method/ESC|#BEscape Sequence in 2.5.POS Printer Service Object andPrecautions.)
Raster bit image modeNV bit image mode
SetLogo ChangePrintSide Not supported (OPOS_E_ILLEGAL)
MarkFeed
ClearPrintArea
PageModePrint
PrintMemoryBitmap
DrawRuledLine Not supported
-
7/26/2019 Opos1.13apdevguide en Rev1.00
13/74
13
CITIZEN OPOS DRIVER 1.13 Application Development Guide
CT-S2000
Method NotesStatus of support by the driver
(CT-S2000_*)
Open
Close
ClaimDevice
Notes on Serial I/F connection(Refer to ClaimDevice in 2.5.POSPrinter Service Object andPrecautions.)
ReleaseDevice
CheckHealthOPOS_CH_EXTERNALOnly (self diagnostic printing) issupported.
OPOS_CH_EXTERNAL
ClearInput Not applicable with OPOSPrinter Not applied because no input device is used.
ClearOutputData being transmitted cannot bestopped.
CompareFirmwareVersion Not supported
DirectIO Not supportedResetStatistics Not supported (OPOS_E_ILLEGAL)
RetrieveStatistics Not supported (OPOS_E_ILLEGAL)
UpdateFirmware Not supported
UpdateStatistics Not supported (OPOS_E_ILLEGAL)
PrintNormal
PrintTwoNormal Not supported
PrintImmediate
BeginInsertion Not supported
EndInsertion Not supported
BeginRemoval Not supported
EndRemoval Not supported
CutPaper
Partial cut (1-99)
Full cut (0, 100)RotatePrint (Refer to RotatePrint in 2.5.
POS Printer Service Object andPrecautions.)
PrintBarCode (Refer to PrintBarcode in 2.5.POSPrinter Service Object andPrecautions.)
PrintBitmap Raster bit image printing
TransactionPrint
ValidateData
SetBitmap (Refer to SetBitmap Method/ESC|#BEscape Sequence in 2.5.POS Printer Service Object and
Precautions.)
Raster bit image modeNV bit image mode
SetLogo
ChangePrintSide Not supported (OPOS_E_ILLEGAL)
MarkFeed
ClearPrintArea
PageModePrint
PrintMemoryBitmap
DrawRuledLine Not supported
-
7/26/2019 Opos1.13apdevguide en Rev1.00
14/74
14
CITIZEN OPOS DRIVER 1.13 Application Development Guide
CT-S601/651/801/851
Method NotesStatus of support by the driver
(CT-S601/651/801/851_*)
Open
Close
ClaimDevice
Notes on Serial I/F connection(Refer to ClaimDevice in 2.5.POSPrinter Service Object andPrecautions.)
ReleaseDevice
CheckHealthOPOS_CH_EXTERNALOnly (self diagnostic printing) issupported.
OPOS_CH_EXTERNAL
ClearInput Not applicable with OPOSPrinter Not applied because no input device is used.
ClearOutputData being transmitted cannot bestopped.
CompareFirmwareVersion Not supported
DirectIO Not supportedResetStatistics Not supported (OPOS_E_ILLEGAL)
RetrieveStatistics Not supported (OPOS_E_ILLEGAL)
UpdateFirmware Not supported
UpdateStatistics Not supported (OPOS_E_ILLEGAL)
PrintNormal
PrintTwoNormal Not supported
PrintImmediate
BeginInsertion Not supported
EndInsertion Not supported
BeginRemoval Not supported
EndRemoval Not supported
CutPaper
Partial cut (1-99)
Full cut (0, 100)RotatePrint (Refer to RotatePrint in 2.5.
POS Printer Service Object andPrecautions.)
PrintBarCode (Refer to PrintBarcode in 2.5.POSPrinter Service Object andPrecautions.)
PrintBitmap Raster bit image printing
TransactionPrint
ValidateData
SetBitmap (Refer to SetBitmap Method/ESC|#BEscape Sequence in 2.5.POS Printer Service Object and
Precautions.)
Raster bit image modeNV bit image mode
SetLogo
ChangePrintSide Not supported (OPOS_E_ILLEGAL)
MarkFeed
ClearPrintArea
PageModePrint
PrintMemoryBitmap
DrawRuledLine Not supported
-
7/26/2019 Opos1.13apdevguide en Rev1.00
15/74
15
CITIZEN OPOS DRIVER 1.13 Application Development Guide
CT-S4000
Method NotesStatus of support by the driver
(CT-S4000_*)
Open
Close
ClaimDevice
Notes on Serial I/F connection(Refer to ClaimDevice in 2.5.POSPrinter Service Object andPrecautions.)
ReleaseDevice
CheckHealthOPOS_CH_EXTERNALOnly (self diagnostic printing) issupported.
OPOS_CH_EXTERNAL
ClearInput Not applicable with OPOSPrinter Not applied because no input device is used.
ClearOutputData being transmitted cannot bestopped.
CompareFirmwareVersion Not supported
DirectIO Not supportedResetStatistics Not supported (OPOS_E_ILLEGAL)
RetrieveStatistics Not supported (OPOS_E_ILLEGAL)
UpdateFirmware Not supported
UpdateStatistics Not supported (OPOS_E_ILLEGAL)
PrintNormal
PrintTwoNormal Not supported
PrintImmediate
BeginInsertion Not supported
EndInsertion Not supported
BeginRemoval Not supported
EndRemoval Not supported
CutPaper
Partial cut (1-99)
Full cut (0, 100)RotatePrint (Refer to RotatePrint in 2.5.
POS Printer Service Object andPrecautions.)
PrintBarCode (Refer to PrintBarcode in 2.5.POSPrinter Service Object andPrecautions.)
PrintBitmap Raster bit image printing
TransactionPrint
ValidateData
SetBitmap (Refer to SetBitmap Method/ESC|#BEscape Sequence in 2.5.POS Printer Service Object and
Precautions.)
Raster bit image modeNV bit image mode
SetLogo
ChangePrintSide Not supported (OPOS_E_ILLEGAL)
MarkFeed
ClearPrintArea
PageModePrint
PrintMemoryBitmap
DrawRuledLine Not supported
-
7/26/2019 Opos1.13apdevguide en Rev1.00
16/74
16
CITIZEN OPOS DRIVER 1.13 Application Development Guide
CD-S500
Method NotesStatus of support by the driver
(CD-S500_*)
Open
Close
ClaimDevice
Notes on Serial I/F connection(Refer to ClaimDevice in 2.5.POSPrinter Service Object andPrecautions.)
ReleaseDevice
CheckHealthOPOS_CH_EXTERNALOnly (self diagnostic printing) issupported.
OPOS_CH_EXTERNAL
ClearInput Not applicable with OPOSPrinter Not applied because no input device is used.
ClearOutputData being transmitted cannot bestopped.
CompareFirmwareVersion Not supported
DirectIO Not supportedResetStatistics Not supported (OPOS_E_ILLEGAL)
RetrieveStatistics Not supported (OPOS_E_ILLEGAL)
UpdateFirmware Not supported
UpdateStatistics Not supported (OPOS_E_ILLEGAL)
PrintNormal
PrintTwoNormal Not supported
PrintImmediate
BeginInsertion Not supported
EndInsertion Not supported
BeginRemoval Not supported
EndRemoval Not supported
CutPaper
Partial cut (1-99)
Full cut (0, 100)RotatePrint Not supported
PrintBarCode Not supported
PrintBitmap
TransactionPrint
ValidateData
SetBitmap (Refer to SetBitmap Method/ESC|#BEscape Sequence in 2.5.POS Printer Service Object andPrecautions.)
Raster bit image modeNV bit image mode
SetLogo
ChangePrintSide Not supported (OPOS_E_ILLEGAL)
MarkFeed Not supported
ClearPrintArea Not supported
ageModePrint Not supported
PrintMemoryBitmap Not supported
DrawRuledLine Not supported
-
7/26/2019 Opos1.13apdevguide en Rev1.00
17/74
17
CITIZEN OPOS DRIVER 1.13 Application Development Guide
2.2. POS Printer Service Object and Property Relations
CT-S281
Property Notes Attribute
Status of support by the driver(CT-S281_*)
AutoDisable Not applicable with OPOSPrinter R/W Not supported
BinaryConversion (Refer to BinaryConversion in2.5.POS Printer Service Objectand Precautions.)
R/W OPOS_BC_NONE (Default value)OPOS_BC_NIBBLEOPOS_BC_DECIMAL
CapCompareFirmwareVersion R Not supported
CapPowerReporting R OPOS_PR_STANDARD
CapstatisticsReporting R FALSE
CapUpdateFirmware R Not supported
CapUpdateStatistics R FALSE
CheckHealthText R External HCheck: Successful
Claimed R ClaimeDeviceTrue
ReleaseDeviceFalse
DataCount Not applicable with OPOSPrinter R Not applied because no input device isused.
DataEventEnabled Not applicable with OPOSPrinter R/W Not applied because no input device isused.
DeviceEnabled R/W TRUEDataEvent notified
False: DataEvent not notified
FreezeEvents R/W TRUE Event notification disabled
FALSE: Event notification enabled
OpenResult R In other than OPOS_SUCCESS, refer toOpenResult properties in OPENPOS FOROLE APPLICATION PROGRAMMERSGUIDE Japanese-edition Specification
Version 1.13.OutputID (Refer to OutPutID property/
OutputCompleteEvent event in2.5.POS Printer Service Objectand Precautions.)
R Increment (+1)
PowerNotify R/W OPOS_PN_DISABLE(Power notification is not supplied.)OPOS_PN_ENABLE(Information on power notification issupplied.)
PowerState R Online and Ready stateOPOS_PS_ONLINE(2001)
Not Ready state
OPOS_PS_OFFLINE(2003)ResultCode (Refer to ResultCode/
ResultCodeExtended Property in2.5.POS Printer Service Objectand Precautions.)
R In other than OPOS_SUCCESS, refer toResulCode properties in OPENPOS FOROLE APPLICATION PROGRAMMERSGUIDE Japanese-edition Specification
Version 1.13.
ResultCodeExtended (Refer to ResultCode/ResultCodeExtended Property in2.5.POS Printer Service Objectand Precautions.)
R
State R In other than OPOSIDLE, refer to Stateproperties in OPENPOS FOR OLE
APPLICATION PROGRAMMERS GUIDEJapanese-edition Specification Version
1.13.ControlObjectDescription R 1.13***
ControlObjectVersion R 1.13***
-
7/26/2019 Opos1.13apdevguide en Rev1.00
18/74
18
CITIZEN OPOS DRIVER 1.13 Application Development Guide
Property NotesAttrib
uteStatus of support by the driver
(CT-S281_*)
ServiceObjectDescription R Citizen Systems Service Object forThermal PosPrinters ver *.**.**
ServiceObjectVersion R 1******
DeviceDescription R Citizen Systems Thermal POSPrinter.
DeviceName R CT-S281CapCharacterSet R PTR_CCS_KANJI
CapConcurrentJrnRec R Not supported
CapConcurrentPageMode R Not supported
CapConcurrentJrnSlp R Not supported
CapConcurrentRecSlp R Not supported
CapCoverSensor R TRUE: With cover open sensor
CapTransaction R TRUE: Batch processing of characters ispossible.
CapJrnPresent R Not supported
CapJrn2Color R Not supported
CapJrnBold R Not supported
CapJrnDhigh R Not supported
CapJrnDwide R Not supported
CapJrnDwideDhigh R Not supported
CapJrnEmptySensor R Not supported
CapJrnItalic R Not supported
CapJrnNearEndSensor R Not supported
CapJrnUnderline R Not supported
CapJrnCartridgeSensor R Not supported
CapJrnColor R Not supported
CapRecPresent R TRUE Receipt is possible.
CapRec2Color R TRUE 2-color printing is possible.
(Using paper printable in 2 colors)
CapRecBarCode R TRUE: Barcode printing is possible.
CapRecBitmap R TRUE: Bitmap printing is possible.CapRecBold R TRUE: Bold attribute setting is possible.
CapRecDhigh R TRUE: Double height attribute setting ispossible.
CapRecDwide R TRUE: Double width setting is possible.
CapRecDwideDhigh R TRUE: Quadruple attribute setting ispossible.
CapRecEmptySensor R TRUE: Paper-Out sensor is active.FALSE: Paper-Out sensor is non-active.
CapRecItalic R Not supported
CapRecLeft90 R TRUE: 90-degree CCW rotation attributesetting is possible.
CapRecNearEndSensor R TRUE: With Paper Near-End sensor
CapRecPapercut R Only partial cut (90) is supported.CapRecRight90 R TRUE: 90-degree CW rotation attribute
setting is possible.
CapRecRotate180 R TRUE: 180-degree rotation attributesetting is possible.
CapRecStamp R Not supported
CapRecUnderline R TRUE: Underline attribute setting ispossible.
CapRecCartridgeSensor R PTR_CART_OK
CapRecColor R PTR_CUSTOM_COLOR1
CapRecMarkFeed R PTR_MF_TO_CUTTER
CapRecPageMode R TRUE: Page Mode Printing is possible.
CapRecRuledLine R Not supported
CapSlpPresent R Not supported
CapSlpFullslip R Not supported
CapSlp2Color R Not supported
CapSlpBarCode R Not supported
-
7/26/2019 Opos1.13apdevguide en Rev1.00
19/74
19
CITIZEN OPOS DRIVER 1.13 Application Development Guide
Property NotesAttrib
uteStatus of support by the driver
(CT-S281_*)
CapSlpBitmap R Not supported
CapSlpBold R Not supported
CapSlpDhigh R Not supported
CapSlpDwide R Not supported
CapSlpDwideDhigh R Not supportedCapSlpEmptySensor R Not supported
CapSlpItalic R Not supported
CapSlpLeft90 R Not supported
CapSlpNearEndSensor R Not supported
CapSlpRight90 R Not supported
CapSlpRotate180 R Not supported
CapSlpUnderline R Not supported
CapSlpBothSidesPrint R Not supported
CapSlpCartridgeSensor R Not supported
CapSlpColor R Not supported
CapSlpPageMode R Not supported
CapSlpRuledLine R Not supported
AsyncMode (Refer to AsyncMode Propertyin 2.5.POS Printer ServiceObject and Precautions.)
R/W TRUE/FALSE
CartridgeNotify R/W Not supported
CharacterSet R/W Default valueJapanese version: Code932English version: Code437
CharacterSetList R 255: User Defined437: Code437850: Code850 Multilingual860: Code860 Portugal863: Code863 Canada-French865: Code865 Norway
852: Code852 Eastern Europe858: Code858864: Code864 Arabic874: Code874 Tai Code 18866: Code866 Russia857: Code857 Turkey932: KANA998: ASCII999: Windows Code1252: Windows Code
CoverOpen R TRUE: POS printer cover is open.FALSE: POS printer cover is closed.
ErrorLevel (Refer to ErrorLevel Property in2.5.POS Printer Service Object
and Precautions.)
R PTR_EL_NONEPTR_EL_RECOVERABLE
PTR_EL_FATALErrorStation R PTR_S_RECEIPT
ErrorString R Description on present error is retained.
FontTypefaceList R Font A, B, C
FlagWhenIdle R/W
MapMode R/W PTR_MM_DOTS (Default value)PTR_MM_TWIPSPTR_MM_ENGLISHPTR_MM_METRIC
PageModeArea R www,738(www==RecLineWidth)
PageModeDescriptor R PTR_PM_BITMAP |
PTR_BM_BARCODE |
PTR_BM_BM_ROTATE |
PTR_BM_BC_ROTATE
PageModeHorizontalPosition R/W
PageModePrintArea R/W
-
7/26/2019 Opos1.13apdevguide en Rev1.00
20/74
20
CITIZEN OPOS DRIVER 1.13 Application Development Guide
Property NotesAttrib
uteStatus of support by the driver
(CT-S281_*)
PageModePrintDirection R/W
PageModeStation R/W PTR_S_RECEIPT
PageModeVerticalPosition R/W
RotateSpecial R/W PTR_RP_NORMAL
PTR_RP_RIGHT90PTR_RP_LEFT90PTR_RP_ROTATE180
JrnLineChars R/W Not supported
JrnLineCharsList R Not supported
JrnLineHeight R/W Not supported
JrnLineSpacing R/W Not supported
JrnLineWidth R Not supported
JrnLetterQuality R/W Not supported
JrnEmpty R Not supported
JrnNearEnd R Not supported
JrnCartridgeState R Not supported
JrnCurrentCartridge R/W Not supported
RecLineChars According to the value, the Fontsize is changed. Value shouldbe chosen fromRecLineCharsList property.(Refer to RecLineChars/RecLineCharsList Property in2.5.POS Printer Service Objectand Precautions)
R/W OPOS_SUCCESS(Normal setting)OPOS_E_ILLEGAL(Illegal line character width is specified.)
RecLineCharsList (Refer to RecLineChars/RecLineCharsList Property in2.5.POS Printer Service Objectand Precautions.)
R
RecLineHeight The value is changed according
to the RecLineChars property.
R/W
RecLineSpacing If the value is smaller thanRecLineHeight, the value ischanged according to theRecLineHeight property.
R/W
RecLineWidth R
RecLetterQuality R/W Not supported
RecEmpty R TRUE: Receipt paper outFALSE: With receipt paper
RecNearEnd R
RecSidewaysMaxLines (Refer to RecSidewaysMaxLinesProperty in 2.5.POS PrinterService Object andPrecautions.)
R
RecSidewaysMaxChars (Refer to RecSidewaysMaxCharsProperty in 2.5.POS PrinterService Object andPrecautions.)
R
RecLinesToPaperCut R
RecBarCodeRotationList R 0,R90,L90,180
RecCartridgeState R Not supported
RecCurrentCartridge R/W PTR_COLOR_PRIMARYPTR_COLOR_CUSTOM1
RecBitmapRotationList R 0,R90,L90,180
SlpLineChars R/W Not supported
SlpLineCharsList R Not supported
SlpLineHeight R/W Not supportedSlpLineSpacing R/W Not supported
SlpLineWidth R Not supported
SlpLetterQuality R/W Not supported
-
7/26/2019 Opos1.13apdevguide en Rev1.00
21/74
21
CITIZEN OPOS DRIVER 1.13 Application Development Guide
Property NotesAttrib
uteStatus of support by the driver
(CT-S281_*)
SlpEmpty R Not supported
SlpNearEnd R Not supported
SlpSidewaysMaxLines R Not supported
SlpSidewaysMaxChars R Not supported
SlpMaxLines R Not supportedSlpLinesNearEndToEnd R Not supported
SlpBarCodeRotationList R Not supported
SlpPrintSide R Not supported
SlpCartridgeState R Not supported
SlpCurrentCartridge R/W Not supported
-
7/26/2019 Opos1.13apdevguide en Rev1.00
22/74
22
CITIZEN OPOS DRIVER 1.13 Application Development Guide
CT-S310
Property NotesAttrib
uteStatus of support by the driver
(CT-S310_*)
AutoDisable Not applicable with OPOSPrinter R/W Not supported
BinaryConversion (Refer to BinaryConversion in2.5.POS Printer Service Objectand Precautions.)
R/W OPOS_BC_NONE (Default value)OPOS_BC_NIBBLEOPOS_BC_DECIMAL
CapCompareFirmwareVersion R Not supported
CapPowerReporting R OPOS_PR_STANDARD
CapstatisticsReporting R FALSE
CapUpdateFirmware R Not supported
CapUpdateStatistics R FALSE
CheckHealthText R External HCheck: Successful
Claimed R ClaimeDeviceTrue
ReleaseDeviceFalse
DataCount Not applicable with OPOSPrinter R Not applied because no input device isused.
DataEventEnabled Not applicable with OPOSPrinter R/W Not applied because no input device isused.
DeviceEnabled R/W TRUEDataEvent notified
False: DataEvent not notified
FreezeEvents R/W TRUE Event notification disabled
FALSE: Event notification enabled
OpenResult R In other than OPOS_SUCCESS, refer toOpenResult properties in OPENPOS FOROLE APPLICATION PROGRAMMERSGUIDE Japanese-edition Specification
Version 1.13.
OutputID (Refer to OutPutID property/OutputCompleteEvent event in
2.5.POS Printer Service Objectand Precautions.)
R Increment (+1)
PowerNotify R/W OPOS_PN_DISABLE(Power notification is not supplied.)OPOS_PN_ENABLE(Information on power notification issupplied.)
PowerState R Online and Ready stateOPOS_PS_ONLINE(2001)
Not Ready stateOPOS_PS_OFFLINE(2003)
ResultCode (Refer to ResultCode/ResultCodeExtended Property in2.5.POS Printer Service Objectand Precautions.)
R In other than OPOS_SUCCESS, refer toResulCode properties in OPENPOS FOROLE APPLICATION PROGRAMMERSGUIDE Japanese-edition Specification
Version 1.13.
ResultCodeExtended (Refer to ResultCode/ResultCodeExtended Property in2.5.POS Printer Service Objectand Precautions.)
R
State R In other than OPOSIDLE, refer to Stateproperties in OPENPOS FOR OLE
APPLICATION PROGRAMMERS GUIDEJapanese-edition Specification Version1.13.
ControlObjectDescription R 1.13***
ControlObjectVersion R 1.13***
ServiceObjectDescription R Citizen Systems Service Object forThermal PosPrinters ver *.**.**
ServiceObjectVersion R 1******
DeviceDescription R Citizen Systems Thermal POSPrinter.
-
7/26/2019 Opos1.13apdevguide en Rev1.00
23/74
23
CITIZEN OPOS DRIVER 1.13 Application Development Guide
Property NotesAttrib
uteStatus of support by the driver
(CT-S310_*)
DeviceName R CT-S310
CapCharacterSet R PTR_CCS_KANJI
CapConcurrentJrnRec R Not supported
CapConcurrentPageMode R Not supported
CapConcurrentJrnSlp R Not supportedCapConcurrentRecSlp R Not supported
CapCoverSensor R TRUE: With cover open sensor
CapTransaction R TRUE: Batch processing of characters ispossible.
CapJrnPresent R Not supported
CapJrn2Color R Not supported
CapJrnBold R Not supported
CapJrnDhigh R Not supported
CapJrnDwide R Not supported
CapJrnDwideDhigh R Not supported
CapJrnEmptySensor R Not supported
CapJrnItalic R Not supported
CapJrnNearEndSensor R Not supported
CapJrnUnderline R Not supported
CapJrnCartridgeSensor R Not supported
CapJrnColor R Not supported
CapRecPresent R TRUE Receipt is possible.
CapRec2Color R TRUE 2-color printing is possible.
(Using paper printable in 2 colors)
CapRecBarCode R TRUE: Barcode printing is possible.
CapRecBitmap R TRUE: Bitmap printing is possible.
CapRecBold R TRUE: Bold attribute setting is possible.
CapRecDhigh R TRUE: Double height attribute setting ispossible.
CapRecDwide R TRUE: Double width setting is possible.CapRecDwideDhigh R TRUE: Quadruple attribute setting is
possible.
CapRecEmptySensor R TRUE: Paper-Out sensor is active.FALSE: Paper-Out sensor is non-active.
CapRecItalic R Not supported
CapRecLeft90 R TRUE: 90-degree CCW rotation attributesetting is possible.
CapRecNearEndSensor R TRUE: With Paper Near-End sensor
CapRecPapercut R Only partial cut (90) is supported.
CapRecRight90 R TRUE: 90-degree CW rotation attributesetting is possible.
CapRecRotate180 R TRUE: 180-degree rotation attribute
setting is possible.CapRecStamp R Not supported
CapRecUnderline R TRUE: Underline attribute setting ispossible.
CapRecCartridgeSensor R PTR_CART_OK
CapRecColor R PTR_CUSTOM_COLOR1
CapRecMarkFeed R PTR_MF_TO_CUTTER
CapRecPageMode R TRUE: Page Mode Printing is possible.
CapRecRuledLine R Not supported
CapSlpPresent R Not supported
CapSlpFullslip R Not supported
CapSlp2Color R Not supported
CapSlpBarCode R Not supported
CapSlpBitmap R Not supportedCapSlpBold R Not supported
CapSlpDhigh R Not supported
CapSlpDwide R Not supported
-
7/26/2019 Opos1.13apdevguide en Rev1.00
24/74
24
CITIZEN OPOS DRIVER 1.13 Application Development Guide
Property NotesAttrib
uteStatus of support by the driver
(CT-S310_*)
CapSlpDwideDhigh R Not supported
CapSlpEmptySensor R Not supported
CapSlpItalic R Not supported
CapSlpLeft90 R Not supported
CapSlpNearEndSensor R Not supportedCapSlpRight90 R Not supported
CapSlpRotate180 R Not supported
CapSlpUnderline R Not supported
CapSlpBothSidesPrint R Not supported
CapSlpCartridgeSensor R Not supported
CapSlpColor R Not supported
CapSlpPageMode R Not supported
CapSlpRuledLine R Not supported
AsyncMode (Refer to AsyncMode Propertyin 2.5.POS Printer ServiceObject and Precautions.)
R/W TRUE/FALSE
CartridgeNotify R/W Not supported
CharacterSet R/W Default valueJapanese version: Code932English version: Code437
CharacterSetList R 255: User Defined437: Code437850: Code850 Multilingual860: Code860 Portugal863: Code863 Canada-French865: Code865 Norway852: Code852 Eastern Europe858: Code858864: Code864 Arabic874: Code874 Tai Code 18866: Code866 Russia857: Code857 Turkey932: KANA998: ASCII999: Windows Code1252: Windows Code
CoverOpen R TRUE: POS printer cover is open.FALSE: POS printer cover is closed.
ErrorLevel (Refer to ErrorLevel Property in2.5.POS Printer Service Objectand Precautions.)
R PTR_EL_NONEPTR_EL_RECOVERABLEPTR_EL_FATAL
ErrorStation R PTR_S_RECEIPT
ErrorString R Description on present error is retained.
FontTypefaceList R Font A, B, C
FlagWhenIdle R/W
MapMode R/W PTR_MM_DOTS (Default value)PTR_MM_TWIPSPTR_MM_ENGLISHPTR_MM_METRIC
PageModeArea R www,738(www==RecLineWidth)
PageModeDescriptor R PTR_PM_BITMAP |
PTR_BM_BARCODE |
PTR_BM_BM_ROTATE |
PTR_BM_BC_ROTATE
PageModeHorizontalPosition R/W
PageModePrintArea R/W
PageModePrintDirection R/W
PageModeStation R/W PTR_S_RECEIPT
PageModeVerticalPosition R/W
-
7/26/2019 Opos1.13apdevguide en Rev1.00
25/74
25
CITIZEN OPOS DRIVER 1.13 Application Development Guide
Property NotesAttrib
uteStatus of support by the driver
(CT-S310_*)
RotateSpecial R/W PTR_RP_NORMALPTR_RP_RIGHT90PTR_RP_LEFT90PTR_RP_ROTATE180
JrnLineChars R/W Not supportedJrnLineCharsList R Not supported
JrnLineHeight R/W Not supported
JrnLineSpacing R/W Not supported
JrnLineWidth R Not supported
JrnLetterQuality R/W Not supported
JrnEmpty R Not supported
JrnNearEnd R Not supported
JrnCartridgeState R Not supported
JrnCurrentCartridge R/W Not supported
RecLineChars According to the value, the Fontsize is changed. Value shouldbe chosen from
RecLineCharsList property.(Refer to RecLineChars/RecLineCharsList Property in2.5.POS Printer Service Objectand Precautions)
R/W OPOS_SUCCESS(Normal setting)OPOS_E_ILLEGAL
(Illegal line character width is specified.)
RecLineCharsList (Refer to RecLineChars/RecLineCharsList Property in2.5.POS Printer Service Objectand Precautions.)
R
RecLineHeight The value is changed accordingto the RecLineChars property.
R/W
RecLineSpacing If the value is smaller thanRecLineHeight, the value ischanged according to the
RecLineHeight property.
R/W
RecLineWidth R
RecLetterQuality R/W Not supported
RecEmpty R TRUE: Receipt paper outFALSE: With receipt paper
RecNearEnd R
RecSidewaysMaxLines (Refer to RecSidewaysMaxLinesProperty in 2.5.POS PrinterService Object andPrecautions.)
R
RecSidewaysMaxChars (Refer to RecSidewaysMaxCharsProperty in 2.5.POS PrinterService Object and
Precautions.)
R
RecLinesToPaperCut R
RecBarCodeRotationList R 0,R90,L90,180
RecCartridgeState R Not supported
RecCurrentCartridge R/W PTR_COLOR_PRIMARYPTR_COLOR_CUSTOM1
RecBitmapRotationList R 0,R90,L90,180
SlpLineChars R/W Not supported
SlpLineCharsList R Not supported
SlpLineHeight R/W Not supported
SlpLineSpacing R/W Not supported
SlpLineWidth R Not supported
SlpLetterQuality R/W Not supported
SlpEmpty R Not supported
SlpNearEnd R Not supported
SlpSidewaysMaxLines R Not supported
SlpSidewaysMaxChars R Not supported
-
7/26/2019 Opos1.13apdevguide en Rev1.00
26/74
26
CITIZEN OPOS DRIVER 1.13 Application Development Guide
Property NotesAttrib
uteStatus of support by the driver
(CT-S310_*)
SlpMaxLines R Not supported
SlpLinesNearEndToEnd R Not supported
SlpBarCodeRotationList R Not supported
SlpPrintSide R Not supported
SlpCartridgeState R Not supportedSlpCurrentCartridge R/W Not supported
-
7/26/2019 Opos1.13apdevguide en Rev1.00
27/74
27
CITIZEN OPOS DRIVER 1.13 Application Development Guide
CT-S2000
Property NotesAttrib
uteStatus of support by the driver
(CT-S2000_*)
AutoDisable Not applicable with OPOSPrinter R/W Not supported
BinaryConversion (Refer to BinaryConversion in2.5.POS Printer Service Objectand Precautions.)
R/W OPOS_BC_NONE (Default value)OPOS_BC_NIBBLEOPOS_BC_DECIMAL
CapCompareFirmwareVersion R Not supported
CapPowerReporting R OPOS_PR_STANDARD
CapstatisticsReporting R FALSE
CapUpdateFirmware R Not supported
CapUpdateStatistics R FALSE
CheckHealthText R External HCheck: Successful
Claimed R ClaimeDeviceTrue
ReleaseDeviceFalse
DataCount Not applicable with OPOSPrinter R Not applied because no input device isused.
DataEventEnabled Not applicable with OPOSPrinter R/W Not applied because no input device isused.
DeviceEnabled R/W TRUEDataEvent notified
False: DataEvent not notified
FreezeEvents R/W TRUE Event notification disabled
FALSE: Event notification enabled
OpenResult R In other than OPOS_SUCCESS, refer toOpenResult properties in OPENPOS FOROLE APPLICATION PROGRAMMERSGUIDE Japanese-edition Specification
Version 1.13.
OutputID (Refer to OutPutID property/OutputCompleteEvent event in
2.5.POS Printer Service Objectand Precautions.)
R Increment (+1)
PowerNotify R/W OPOS_PN_DISABLE(Power notification is not supplied.)OPOS_PN_ENABLE(Information on power notification issupplied.)
PowerState R Online and Ready stateOPOS_PS_ONLINE(2001)
Not Ready stateOPOS_PS_OFFLINE(2003)
ResultCode (Refer to ResultCode/ResultCodeExtended Property in2.5.POS Printer Service Objectand Precautions.)
R In other than OPOS_SUCCESS, refer toResulCode properties in OPENPOS FOROLE APPLICATION PROGRAMMERSGUIDE Japanese-edition Specification
Version 1.13.
ResultCodeExtended (Refer to ResultCode/ResultCodeExtended Property in2.5.POS Printer Service Objectand Precautions.)
R
State R In other than OPOSIDLE, refer to Stateproperties in OPENPOS FOR OLE
APPLICATION PROGRAMMERS GUIDEJapanese-edition Specification Version1.13.
ControlObjectDescription R 1.13***
ControlObjectVersion R 1.13***
ServiceObjectDescription R Citizen Systems Service Object forThermal PosPrinters ver *.**.**
ServiceObjectVersion R 1******
DeviceDescription R Citizen Systems Thermal POSPrinter.
-
7/26/2019 Opos1.13apdevguide en Rev1.00
28/74
28
CITIZEN OPOS DRIVER 1.13 Application Development Guide
Property NotesAttrib
uteStatus of support by the driver
(CT-S2000_*)
DeviceName R CT-S2000
CapCharacterSet R PTR_CCS_KANJI
CapConcurrentJrnRec R Not supported
CapConcurrentPageMode R Not supported
CapConcurrentJrnSlp R Not supportedCapConcurrentRecSlp R Not supported
CapCoverSensor R TRUE: With cover open sensor
CapTransaction R TRUE: Batch processing of characters ispossible.
CapJrnPresent R Not supported
CapJrn2Color R Not supported
CapJrnBold R Not supported
CapJrnDhigh R Not supported
CapJrnDwide R Not supported
CapJrnDwideDhigh R Not supported
CapJrnEmptySensor R Not supported
CapJrnItalic R Not supported
CapJrnNearEndSensor R Not supported
CapJrnUnderline R Not supported
CapJrnCartridgeSensor R Not supported
CapJrnColor R Not supported
CapRecPresent R TRUE Receipt is possible.
CapRec2Color R TRUE 2-color printing is possible.
(Using paper printable in 2 colors)
CapRecBarCode R TRUE: Barcode printing is possible.
CapRecBitmap R TRUE: Bitmap printing is possible.
CapRecBold R TRUE: Bold attribute setting is possible.
CapRecDhigh R TRUE: Double height attribute setting ispossible.
CapRecDwide R TRUE: Double width setting is possible.CapRecDwideDhigh R TRUE: Quadruple attribute setting is
possible.
CapRecEmptySensor R TRUE: Paper-Out sensor is active.FALSE: Paper-Out sensor is non-active.
CapRecItalic R Not supported
CapRecLeft90 R TRUE: 90-degree CCW rotation attributesetting is possible.
CapRecNearEndSensor R TRUE: With Paper Near-End sensor
CapRecPapercut R Only partial cut (90) is supported.
CapRecRight90 R TRUE: 90-degree CW rotation attributesetting is possible.
CapRecRotate180 R TRUE: 180-degree rotation attribute
setting is possible.CapRecStamp R Not supported
CapRecUnderline R TRUE: Underline attribute setting ispossible.
CapRecCartridgeSensor R PTR_CART_OK
CapRecColor R PTR_CUSTOM_COLOR1
CapRecMarkFeed R PTR_MF_TO_CUTTER
CapRecPageMode R TRUE: Page Mode Printing is possible.
CapRecRuledLine R Not supported
CapSlpPresent R Not supported
CapSlpFullslip R Not supported
CapSlp2Color R Not supported
CapSlpBarCode R Not supported
CapSlpBitmap R Not supportedCapSlpBold R Not supported
CapSlpDhigh R Not supported
CapSlpDwide R Not supported
-
7/26/2019 Opos1.13apdevguide en Rev1.00
29/74
29
CITIZEN OPOS DRIVER 1.13 Application Development Guide
Property NotesAttrib
uteStatus of support by the driver
(CT-S2000_*)
CapSlpDwideDhigh R Not supported
CapSlpEmptySensor R Not supported
CapSlpItalic R Not supported
CapSlpLeft90 R Not supported
CapSlpNearEndSensor R Not supportedCapSlpRight90 R Not supported
CapSlpRotate180 R Not supported
CapSlpUnderline R Not supported
CapSlpBothSidesPrint R Not supported
CapSlpCartridgeSensor R Not supported
CapSlpColor R Not supported
CapSlpPageMode R Not supported
CapSlpRuledLine R Not supported
AsyncMode (Refer to AsyncMode Propertyin 2.5.POS Printer ServiceObject and Precautions.)
R/W TRUE/FALSE
CartridgeNotify R/W Not supported
CharacterSet R/W Default valueJapanese version: Code932English version: Code437
CharacterSetList R 255: User Defined437: Code437850: Code850 Multilingual860: Code860 Portugal863: Code863 Canada-French865: Code865 Norway852: Code852 Eastern Europe858: Code858864: Code864 Arabic874: Code874 Tai Code 18866: Code866 Russia857: Code857 Turkey932: KANA998: ASCII999: Windows Code1252: Windows Code
CoverOpen R TRUE: POS printer cover is open.FALSE: POS printer cover is closed.
ErrorLevel (Refer to ErrorLevel Property in2.5.POS Printer Service Objectand Precautions.)
R PTR_EL_NONEPTR_EL_RECOVERABLEPTR_EL_FATAL
ErrorStation R PTR_S_RECEIPT
ErrorString R Description on present error is retained.
FontTypefaceList R Font A, B, C
FlagWhenIdle R/W
MapMode R/W PTR_MM_DOTS (Default value)PTR_MM_TWIPSPTR_MM_ENGLISHPTR_MM_METRIC
PageModeArea R www,738(www==RecLineWidth)
PageModeDescriptor R PTR_PM_BITMAP |
PTR_BM_BARCODE |
PTR_BM_BM_ROTATE |
PTR_BM_BC_ROTATE
PageModeHorizontalPosition R/W
PageModePrintArea R/W
PageModePrintDirection R/W
PageModeStation R/W PTR_S_RECEIPT
PageModeVerticalPosition R/W
-
7/26/2019 Opos1.13apdevguide en Rev1.00
30/74
30
CITIZEN OPOS DRIVER 1.13 Application Development Guide
Property NotesAttrib
uteStatus of support by the driver
(CT-S2000_*)
RotateSpecial R/W PTR_RP_NORMALPTR_RP_RIGHT90PTR_RP_LEFT90PTR_RP_ROTATE180
JrnLineChars R/W Not supportedJrnLineCharsList R Not supported
JrnLineHeight R/W Not supported
JrnLineSpacing R/W Not supported
JrnLineWidth R Not supported
JrnLetterQuality R/W Not supported
JrnEmpty R Not supported
JrnNearEnd R Not supported
JrnCartridgeState R Not supported
JrnCurrentCartridge R/W Not supported
RecLineChars According to the value, the Fontsize is changed. Value shouldbe chosen from
RecLineCharsList property.(Refer to RecLineChars/RecLineCharsList Property in2.5.POS Printer Service Objectand Precautions)
R/W OPOS_SUCCESS(Normal setting)OPOS_E_ILLEGAL
(Illegal line character width is specified.)
RecLineCharsList (Refer to RecLineChars/RecLineCharsList Property in2.5.POS Printer Service Objectand Precautions.)
R
RecLineHeight The value is changed accordingto the RecLineChars property.
R/W
RecLineSpacing If the value is smaller thanRecLineHeight, the value ischanged according to the
RecLineHeight property.
R/W
RecLineWidth R
RecLetterQuality R/W Not supported
RecEmpty R TRUE: Receipt paper outFALSE: With receipt paper
RecNearEnd R
RecSidewaysMaxLines (Refer to RecSidewaysMaxLinesProperty in 2.5.POS PrinterService Object andPrecautions.)
R
RecSidewaysMaxChars (Refer to RecSidewaysMaxCharsProperty in 2.5.POS PrinterService Object and
Precautions.)
R
RecLinesToPaperCut R
RecBarCodeRotationList R 0,R90,L90,180
RecCartridgeState R Not supported
RecCurrentCartridge R/W PTR_COLOR_PRIMARYPTR_COLOR_CUSTOM1
RecBitmapRotationList R 0,R90,L90,180
SlpLineChars R/W Not supported
SlpLineCharsList R Not supported
SlpLineHeight R/W Not supported
SlpLineSpacing R/W Not supported
SlpLineWidth R Not supported
SlpLetterQuality R/W Not supported
SlpEmpty R Not supported
SlpNearEnd R Not supported
SlpSidewaysMaxLines R Not supported
SlpSidewaysMaxChars R Not supported
-
7/26/2019 Opos1.13apdevguide en Rev1.00
31/74
31
CITIZEN OPOS DRIVER 1.13 Application Development Guide
Property NotesAttrib
uteStatus of support by the driver
(CT-S2000_*)
SlpMaxLines R Not supported
SlpLinesNearEndToEnd R Not supported
SlpBarCodeRotationList R Not supported
SlpPrintSide R Not supported
SlpCartridgeState R Not supportedSlpCurrentCartridge R/W Not supported
-
7/26/2019 Opos1.13apdevguide en Rev1.00
32/74
32
CITIZEN OPOS DRIVER 1.13 Application Development Guide
CT-S601/651/801/851
Property NotesAttrib
uteStatus of support by the driver
(CT-S601/651/801/851_*)
AutoDisable Not applicable with OPOSPrinter R/W Not supported
BinaryConversion (Refer to BinaryConversion in2.5.POS Printer Service Objectand Precautions.)
R/W OPOS_BC_NONE (Default value)OPOS_BC_NIBBLEOPOS_BC_DECIMAL
CapCompareFirmwareVersion R Not supported
CapPowerReporting R OPOS_PR_STANDARD
CapstatisticsReporting R FALSE
CapUpdateFirmware R Not supported
CapUpdateStatistics R FALSE
CheckHealthText R External HCheck: Successful
Claimed R ClaimeDeviceTrue
ReleaseDeviceFalse
DataCount Not applicable with OPOSPrinter R Not applied because no input device isused.
DataEventEnabled Not applicable with OPOSPrinter R/W Not applied because no input device isused.
DeviceEnabled R/W TRUEDataEvent notified
False: DataEvent not notified
FreezeEvents R/W TRUE Event notification disabled
FALSE: Event notification enabled
OpenResult R In other than OPOS_SUCCESS, refer toOpenResult properties in OPENPOS FOROLE APPLICATION PROGRAMMERSGUIDE Japanese-edition Specification
Version 1.13.
OutputID (Refer to OutPutID property/OutputCompleteEvent event in
2.5.POS Printer Service Objectand Precautions.)
R Increment (+1)
PowerNotify R/W OPOS_PN_DISABLE(Power notification is not supplied.)OPOS_PN_ENABLE(Information on power notification issupplied.)
PowerState R Online and Ready stateOPOS_PS_ONLINE(2001)
Not Ready stateOPOS_PS_OFFLINE(2003)
ResultCode (Refer to ResultCode/ResultCodeExtended Property in2.5.POS Printer Service Objectand Precautions.)
R In other than OPOS_SUCCESS, refer toResulCode properties in OPENPOS FOROLE APPLICATION PROGRAMMERSGUIDE Japanese-edition Specification
Version 1.13.
ResultCodeExtended (Refer to ResultCode/ResultCodeExtended Property in2.5.POS Printer Service Objectand Precautions.)
R
State R In other than OPOSIDLE, refer to Stateproperties in OPENPOS FOR OLE
APPLICATION PROGRAMMERS GUIDEJapanese-edition Specification Version1.13.
ControlObjectDescription R 1.13***
ControlObjectVersion R 1.13***
ServiceObjectDescription R Citizen Systems Service Object forThermal PosPrinters ver *.**.**
ServiceObjectVersion R 1******
DeviceDescription R Citizen Systems Thermal POSPrinter.
-
7/26/2019 Opos1.13apdevguide en Rev1.00
33/74
33
CITIZEN OPOS DRIVER 1.13 Application Development Guide
Property NotesAttrib
uteStatus of support by the driver
(CT-S601/651/801/851_*)
DeviceName R CT-S601CT-S651CT-S801CT-S851
CapCharacterSet R PTR_CCS_KANJICapConcurrentJrnRec R Not supported
CapConcurrentPageMode R Not supported
CapConcurrentJrnSlp R Not supported
CapConcurrentRecSlp R Not supported
CapCoverSensor R TRUE: With cover open sensor
CapTransaction R TRUE: Batch processing of characters ispossible.
CapJrnPresent R Not supported
CapJrn2Color R Not supported
CapJrnBold R Not supported
CapJrnDhigh R Not supported
CapJrnDwide R Not supported
CapJrnDwideDhigh R Not supportedCapJrnEmptySensor R Not supported
CapJrnItalic R Not supported
CapJrnNearEndSensor R Not supported
CapJrnUnderline R Not supported
CapJrnCartridgeSensor R Not supported
CapJrnColor R Not supported
CapRecPresent R TRUE Receipt is possible.
CapRec2Color R TRUE 2-color printing is possible.
(Using paper printable in 2 colors)
CapRecBarCode R TRUE: Barcode printing is possible.
CapRecBitmap R TRUE: Bitmap printing is possible.
CapRecBold R TRUE: Bold attribute setting is possible.
CapRecDhigh R TRUE: Double height attribute setting ispossible.
CapRecDwide R TRUE: Double width setting is possible.
CapRecDwideDhigh R TRUE: Quadruple attribute setting ispossible.
CapRecEmptySensor R TRUE: Paper-Out sensor is active.FALSE: Paper-Out sensor is non-active.
CapRecItalic R Not supported
CapRecLeft90 R TRUE: 90-degree CCW rotation attributesetting is possible.
CapRecNearEndSensor R TRUE: With Paper Near-End sensor
CapRecPapercut R Only partial cut (90) is supported.
CapRecRight90 R TRUE: 90-degree CW rotation attributesetting is possible.
CapRecRotate180 R TRUE: 180-degree rotation attributesetting is possible.
CapRecStamp R Not supported
CapRecUnderline R TRUE: Underline attribute setting ispossible.
CapRecCartridgeSensor R PTR_CART_OK
CapRecColor R PTR_CUSTOM_COLOR1
CapRecMarkFeed R PTR_MF_TO_CUTTER
CapRecPageMode R TRUE: Page Mode Printing is possible.
CapRecRuledLine R Not supported
CapSlpPresent R Not supported
CapSlpFullslip R Not supportedCapSlp2Color R Not supported
CapSlpBarCode R Not supported
CapSlpBitmap R Not supported
-
7/26/2019 Opos1.13apdevguide en Rev1.00
34/74
34
CITIZEN OPOS DRIVER 1.13 Application Development Guide
Property NotesAttrib
uteStatus of support by the driver
(CT-S601/651/801/851_*)
CapSlpBold R Not supported
CapSlpDhigh R Not supported
CapSlpDwide R Not supported
CapSlpDwideDhigh R Not supported
CapSlpEmptySensor R Not supportedCapSlpItalic R Not supported
CapSlpLeft90 R Not supported
CapSlpNearEndSensor R Not supported
CapSlpRight90 R Not supported
CapSlpRotate180 R Not supported
CapSlpUnderline R Not supported
CapSlpBothSidesPrint R Not supported
CapSlpCartridgeSensor R Not supported
CapSlpColor R Not supported
CapSlpPageMode R Not supported
CapSlpRuledLine R Not supported
AsyncMode (Refer to AsyncMode Property
in 2.5.POS Printer ServiceObject and Precautions.)
R/W TRUE/FALSE
CartridgeNotify R/W Not supported
CharacterSet R/W Default valueJapanese version: Code932English version: Code437
CharacterSetList R 255: User Defined437: Code437850: Code850 Multilingual860: Code860 Portugal863: Code863 Canada-French865: Code865 Norway852: Code852 Eastern Europe
858: Code858864: Code864 Arabic874: Code874 Tai Code 18866: Code866 Russia857: Code857 Turkey932: KANA998: ASCII999: Windows Code1252: Windows Code
CoverOpen R TRUE: POS printer cover is open.FALSE: POS printer cover is closed.
ErrorLevel (Refer to ErrorLevel Property in2.5.POS Printer Service Objectand Precautions.)
R PTR_EL_NONEPTR_EL_RECOVERABLEPTR_EL_FATAL
ErrorStation R PTR_S_RECEIPTErrorString R Description on present error is retained.
FontTypefaceList R Font A, B, C
FlagWhenIdle R/W
MapMode R/W PTR_MM_DOTS (Default value)PTR_MM_TWIPSPTR_MM_ENGLISHPTR_MM_METRIC
PageModeArea R www,738(www==RecLineWidth)
PageModeDescriptor R PTR_PM_BITMAP |
PTR_BM_BARCODE |
PTR_BM_BM_ROTATE |
PTR_BM_BC_ROTATE
PageModeHorizontalPosition R/W
PageModePrintArea R/W
-
7/26/2019 Opos1.13apdevguide en Rev1.00
35/74
35
CITIZEN OPOS DRIVER 1.13 Application Development Guide
Property NotesAttrib
uteStatus of support by the driver
(CT-S601/651/801/851_*)
PageModePrintDirection R/W
PageModeStation R/W PTR_S_RECEIPT
PageModeVerticalPosition R/W
RotateSpecial R/W PTR_RP_NORMAL
PTR_RP_RIGHT90PTR_RP_LEFT90PTR_RP_ROTATE180
JrnLineChars R/W Not supported
JrnLineCharsList R Not supported
JrnLineHeight R/W Not supported
JrnLineSpacing R/W Not supported
JrnLineWidth R Not supported
JrnLetterQuality R/W Not supported
JrnEmpty R Not supported
JrnNearEnd R Not supported
JrnCartridgeState R Not supported
JrnCurrentCartridge R/W Not supported
RecLineChars According to the value, the Fontsize is changed. Value shouldbe chosen fromRecLineCharsList property.(Refer to RecLineChars/RecLineCharsList Property in2.5.POS Printer Service Objectand Precautions)
R/W OPOS_SUCCESS(Normal setting)OPOS_E_ILLEGAL(Illegal line character width is specified.)
RecLineCharsList (Refer to RecLineChars/RecLineCharsList Property in2.5.POS Printer Service Objectand Precautions.)
R
RecLineHeight The value is changed according
to the RecLineChars property.
R/W
RecLineSpacing If the value is smaller thanRecLineHeight, the value ischanged according to theRecLineHeight property.
R/W
RecLineWidth R
RecLetterQuality R/W Not supported
RecEmpty R TRUE: Receipt paper outFALSE: With receipt paper
RecNearEnd R
RecSidewaysMaxLines (Refer to RecSidewaysMaxLinesProperty in 2.5.POS PrinterService Object andPrecautions.)
R
RecSidewaysMaxChars (Refer to RecSidewaysMaxCharsProperty in 2.5.POS PrinterService Object andPrecautions.)
R
RecLinesToPaperCut R
RecBarCodeRotationList R 0,R90,L90,180
RecCartridgeState R Not supported
RecCurrentCartridge R/W PTR_COLOR_PRIMARYPTR_COLOR_CUSTOM1
RecBitmapRotationList R 0,R90,L90,180
SlpLineChars R/W Not supported
SlpLineCharsList R Not supported
SlpLineHeight R/W Not supportedSlpLineSpacing R/W Not supported
SlpLineWidth R Not supported
SlpLetterQuality R/W Not supported
-
7/26/2019 Opos1.13apdevguide en Rev1.00
36/74
36
CITIZEN OPOS DRIVER 1.13 Application Development Guide
Property NotesAttrib
uteStatus of support by the driver
(CT-S601/651/801/851_*)
SlpEmpty R Not supported
SlpNearEnd R Not supported
SlpSidewaysMaxLines R Not supported
SlpSidewaysMaxChars R Not supported
SlpMaxLines R Not supportedSlpLinesNearEndToEnd R Not supported
SlpBarCodeRotationList R Not supported
SlpPrintSide R Not supported
SlpCartridgeState R Not supported
SlpCurrentCartridge R/W Not supported
-
7/26/2019 Opos1.13apdevguide en Rev1.00
37/74
37
CITIZEN OPOS DRIVER 1.13 Application Development Guide
CT-S4000
Property NotesAttrib
uteStatus of support by the driver
(CT-S4000_*)
AutoDisable Not applicable with OPOSPrinter R/W Not supported
BinaryConversion (Refer to BinaryConversion in2.5.POS Printer Service Objectand Precautions.)
R/W OPOS_BC_NONE (Default value)OPOS_BC_NIBBLEOPOS_BC_DECIMAL
CapCompareFirmwareVersion R Not supported
CapPowerReporting R OPOS_PR_STANDARD
CapstatisticsReporting R FALSE
CapUpdateFirmware R Not supported
CapUpdateStatistics R FALSE
CheckHealthText R External HCheck: Successful
Claimed R ClaimeDeviceTrue
ReleaseDeviceFalse
DataCount Not applicable with OPOSPrinter R Not applied because no input device isused.
DataEventEnabled Not applicable with OPOSPrinter R/W Not applied because no input device isused.
DeviceEnabled R/W TRUEDataEvent notified
False: DataEvent not notified
FreezeEvents R/W TRUE Event notification disabled
FALSE: Event notification enabled
OpenResult R In other than OPOS_SUCCESS, refer toOpenResult properties in OPENPOS FOROLE APPLICATION PROGRAMMERSGUIDE Japanese-edition Specification
Version 1.13.
OutputID (Refer to OutPutID property/OutputCompleteEvent event in
2.5.POS Printer Service Objectand Precautions.)
R Increment (+1)
PowerNotify R/W OPOS_PN_DISABLE(Power notification is not supplied.)OPOS_PN_ENABLE(Information on power notification issupplied.)
PowerState R Online and Ready stateOPOS_PS_ONLINE(2001)
Not Ready stateOPOS_PS_OFFLINE(2003)
ResultCode (Refer to ResultCode/ResultCodeExtended Property in2.5.POS Printer Service Objectand Precautions.)
R In other than OPOS_SUCCESS, refer toResulCode properties in OPENPOS FOROLE APPLICATION PROGRAMMERSGUIDE Japanese-edition Specification
Version 1.13.
ResultCodeExtended (Refer to ResultCode/ResultCodeExtended Property in2.5.POS Printer Service Objectand Precautions.)
R
State R In other than OPOSIDLE, refer to Stateproperties in OPENPOS FOR OLE
APPLICATION PROGRAMMERS GUIDEJapanese-edition Specification Version1.13.
ControlObjectDescription R 1.13***
ControlObjectVersion R 1.13***
ServiceObjectDescription R Citizen Systems Service Object forThermal PosPrinters ver *.**.**
ServiceObjectVersion R 1******
DeviceDescription R Citizen Systems Thermal POSPrinter.
-
7/26/2019 Opos1.13apdevguide en Rev1.00
38/74
38
CITIZEN OPOS DRIVER 1.13 Application Development Guide
Property NotesAttrib
uteStatus of support by the driver
(CT-S4000_*)
DeviceName R CT-S4000
CapCharacterSet R PTR_CCS_KANJI
CapConcurrentJrnRec R Not supported
CapConcurrentPageMode R Not supported
CapConcurrentJrnSlp R Not supportedCapConcurrentRecSlp R Not supported
CapCoverSensor R TRUE: With cover open sensor
CapTransaction R TRUE: Batch processing of characters ispossible.
CapJrnPresent R Not supported
CapJrn2Color R Not supported
CapJrnBold R Not supported
CapJrnDhigh R Not supported
CapJrnDwide R Not supported
CapJrnDwideDhigh R Not supported
CapJrnEmptySensor R Not supported
CapJrnItalic R Not supported
CapJrnNearEndSensor R Not supported
CapJrnUnderline R Not supported
CapJrnCartridgeSensor R Not supported
CapJrnColor R Not supported
CapRecPresent R TRUE Receipt is possible.
CapRec2Color R TRUE 2-color printing is possible.
(Using paper printable in 2 colors)
CapRecBarCode R TRUE: Barcode printing is possible.
CapRecBitmap R TRUE: Bitmap printing is possible.
CapRecBold R TRUE: Bold attribute setting is possible.
CapRecDhigh R TRUE: Double height attribute setting ispossible.
CapRecDwide R TRUE: Double width setting is possible.CapRecDwideDhigh R TRUE: Quadruple attribute setting is
possible.
CapRecEmptySensor R TRUE: Paper-Out sensor is active.FALSE: Paper-Out sensor is non-active.
CapRecItalic R Not supported
CapRecLeft90 R TRUE: 90-degree CCW rotation attributesetting is possible.
CapRecNearEndSensor R TRUE: With Paper Near-End sensor
CapRecPapercut R Only partial cut (90) is supported.
CapRecRight90 R TRUE: 90-degree CW rotation attributesetting is possible.
CapRecRotate180 R TRUE: 180-degree rotation attribute
setting is possible.CapRecStamp R Not supported
CapRecUnderline R TRUE: Underline attribute setting ispossible.
CapRecCartridgeSensor R PTR_CART_OK
CapRecColor R PTR_CUSTOM_COLOR1
CapRecMarkFeed R PTR_MF_TO_CUTTER
CapRecPageMode R TRUE: Page Mode Printing is possible.
CapRecRuledLine R Not supported
CapSlpPresent R Not supported
CapSlpFullslip R Not supported
CapSlp2Color R Not supported
CapSlpBarCode R Not supported
CapSlpBitmap R Not supportedCapSlpBold R Not supported
CapSlpDhigh R Not supported
CapSlpDwide R Not supported
-
7/26/2019 Opos1.13apdevguide en Rev1.00
39/74
39
CITIZEN OPOS DRIVER 1.13 Application Development Guide
Property NotesAttrib
uteStatus of support by the driver
(CT-S4000_*)
CapSlpDwideDhigh R Not supported
CapSlpEmptySensor R Not supported
CapSlpItalic R Not supported
CapSlpLeft90 R Not supported
CapSlpNearEndSensor R Not supportedCapSlpRight90 R Not supported
CapSlpRotate180 R Not supported
CapSlpUnderline R Not supported
CapSlpBothSidesPrint R Not supported
CapSlpCartridgeSensor R Not supported
CapSlpColor R Not supported
CapSlpPageMode R Not supported
CapSlpRuledLine R Not supported
AsyncMode (Refer to AsyncMode Propertyin 2.5.POS Printer ServiceObject and Precautions.)
R/W TRUE/FALSE
CartridgeNotify R/W Not supported
CharacterSet R/W Default valueJapanese version: Code932English version: Code437
CharacterSetList R 255: User Defined437: Code437850: Code850 Multilingual860: Code860 Portugal863: Code863 Canada-French865: Code865 Norway852: Code852 Eastern Europe858: Code858864: Code864 Arabic874: Code874 Tai Code 18866: Code866 Russia857: Code857 Turkey932: KANA998: ASCII999: Windows Code1252: Windows Code
CoverOpen R TRUE: POS printer cover is open.FALSE: POS printer cover is closed.
ErrorLevel (Refer to ErrorLevel Property in2.5.POS Printer Service Objectand Precautions.)
R PTR_EL_NONEPTR_EL_RECOVERABLEPTR_EL_FATAL
ErrorStation R PTR_S_RECEIPT
ErrorString R Description on present error is retained.
FontTypefaceList R Font A, B, C
FlagWhenIdle R/W
MapMode R/W PTR_MM_DOTS (Default value)PTR_MM_TWIPSPTR_MM_ENGLISHPTR_MM_METRIC
PageModeArea R www,738(www==RecLineWidth)
PageModeDescriptor R PTR_PM_BITMAP |
PTR_BM_BARCODE |
PTR_BM_BM_ROTATE |
PTR_BM_BC_ROTATE
PageModeHorizontalPosition R/W
PageModePrintArea R/W
PageModePrintDirection R/W
PageModeStation R/W PTR_S_RECEIPT
PageModeVerticalPosition R/W
-
7/26/2019 Opos1.13apdevguide en Rev1.00
40/74
40
CITIZEN OPOS DRIVER 1.13 Application Development Guide
Property NotesAttrib
uteStatus of support by the driver
(CT-S4000_*)
RotateSpecial R/W PTR_RP_NORMALPTR_RP_RIGHT90PTR_RP_LEFT90PTR_RP_ROTATE180
JrnLineChars R/W Not supportedJrnLineCharsList R Not supported
JrnLineHeight R/W Not supported
JrnLineSpacing R/W Not supported
JrnLineWidth R Not supported
JrnLetterQuality R/W Not supported
JrnEmpty R Not supported
JrnNearEnd R Not supported
JrnCartridgeState R Not supported
JrnCurrentCartridge R/W Not supported
RecLineChars According to the value, the Fontsize is changed. Value shouldbe chosen from
RecLineCharsList property.(Refer to RecLineChars/RecLineCharsList Property in2.5.POS Printer Service Objectand Precautions)
R/W OPOS_SUCCESS(Normal setting)OPOS_E_ILLEGAL
(Illegal line character width is specified.)
RecLineCharsList (Refer to RecLineChars/RecLineCharsList Property in2.5.POS Printer Service Objectand Precautions.)
R
RecLineHeight The value is changed accordingto the RecLineChars property.
R/W
RecLineSpacing If the value is smaller thanRecLineHeight, the value ischanged according to the
RecLineHeight property.
R/W
RecLineWidth R
RecLetterQuality R/W Not supported
RecEmpty R TRUE: Receipt paper outFALSE: With receipt paper
RecNearEnd R
RecSidewaysMaxLines (Refer to RecSidewaysMaxLinesProperty in 2.5.POS PrinterService Object andPrecautions.)
R
RecSidewaysMaxChars (Refer to RecSidewaysMaxCharsProperty in 2.5.POS PrinterService Object and
Precautions.)
R
RecLinesToPaperCut R
RecBarCodeRotationList R 0,R90,L90,180
RecCartridgeState R Not supported
RecCurrentCartridge R/W PTR_COLOR_PRIMARYPTR_COLOR_CUSTOM1
RecBitmapRotationList R 0,R90,L90,180
SlpLineChars R/W Not supported
SlpLineCharsList R Not supported
SlpLineHeight R/W Not supported
SlpLineSpacing R/W Not supported
SlpLineWidth R Not supported
SlpLetterQuality R/W Not supported
SlpEmpty R Not supported
SlpNearEnd R Not supported
SlpSidewaysMaxLines R Not supported
SlpSidewaysMaxChars R Not supported
-
7/26/2019 Opos1.13apdevguide en Rev1.00
41/74
41
CITIZEN OPOS DRIVER 1.13 Application Development Guide
Property NotesAttrib
uteStatus of support by the driver
(CT-S4000_*)
SlpMaxLines R Not supported
SlpLinesNearEndToEnd R Not supported
SlpBarCodeRotationList R Not supported
SlpPrintSide R Not supported
SlpCartridgeState R Not supportedSlpCurrentCartridge R/W Not supported
-
7/26/2019 Opos1.13apdevguide en Rev1.00
42/74
42
CITIZEN OPOS DRIVER 1.13 Application Development Guide
CD-S500
Property NotesAttrib
uteStatus of support by the driver
(CD-S500_*)
AutoDisable Not applicable with OPOSPrinter R/W Not supported
BinaryConversion (Refer to BinaryConversion in2.5.POS Printer Service Objectand Precautions.)
R/W OPOS_BC_NONE (Default value)OPOS_BC_NIBBLEOPOS_BC_DECIMAL
CapCompareFirmwareVersion R Not supported
CapPowerReporting R OPOS_PR_STANDARD
CapstatisticsReporting R FALSE
CapUpdateFirmware R Not supported
CapUpdateStatistics R FALSE
CheckHealthText R External HCheck: Successful
Claimed R ClaimeDeviceTrue
ReleaseDeviceFalse
DataCount Not applicable with OPOSPrinter R Not applied because no input device isused.
DataEventEnabled Not applicable with OPOSPrinter R/W Not applied because no input device isused.
DeviceEnabled R/W TRUEDataEvent notified
False: DataEvent not notified
FreezeEvents R/W TRUE Event notification disabled
FALSE: Event notification enabled
OpenResult R In other than OPOS_SUCCESS, refer toOpenResult properties in OPENPOS FOROLE APPLICATION PROGRAMMERSGUIDE Japanese-edition Specification
Version 1.13.
OutputID (Refer to OutPutID property/OutputCompleteEvent event in
2.5.POS Printer Service Objectand Precautions.)
R Increment (+1)
PowerNotify R/W OPOS_PN_DISABLE(Power notification is not supplied.)OPOS_PN_ENABLE(Information on power notification issupplied.)
PowerState R Online and Ready stateOPOS_PS_ONLINE(2001)
Not Ready stateOPOS_PS_OFFLINE(2003)
ResultCode (Refer to ResultCode/ResultCodeExtended Property in2.5.POS Printer Service Objectand Precautions.)
R In other than OPOS_SUCCESS, refer toResulCode properties in OPENPOS FOROLE APPLICATION PROGRAMMERSGUIDE Japanese-edition Specification
Version 1.13.
ResultCodeExtended (Refer to ResultCode/ResultCodeExtended Property in2.5.POS Printer Service Objectand Precautions.)
R
State R In other than OPOSIDLE, refer to Stateproperties in OPENPOS FOR OLE
APPLICATION PROGRAMMERS GUIDEJapanese-edition Specification Version1.13.
ControlObjectDescription R 1.13***
ControlObjectVersion R 1.13***
ServiceObjectDescription R Citizen Systems Service Object for DotMatrix PosPrinters ver *.**.**
ServiceObjectVersion R 1******
DeviceDescription R Citizen Systems Dot Matrix POSPrinter.
-
7/26/2019 Opos1.13apdevguide en Rev1.00
43/74
43
CITIZEN OPOS DRIVER 1.13 Application Development Guide
Property NotesAttrib
uteStatus of support by the driver
(CD-S500_*)
DeviceName R CD-S500
CapCharacterSet R PTR_CCS_KANJI
CapConcurrentJrnRec R Not supported
CapConcurrentPageMode R Not supported
CapConcurrentJrnSlp R Not supportedCapConcurrentRecSlp R Not supported
CapCoverSensor R TRUE: With cover open sensor
CapTransaction R TRUE: Batch processing of characters ispossible.
CapJrnPresent R Not supported
CapJrn2Color R Not supported
CapJrnBold R Not supported
CapJrnDhigh R Not supported
CapJrnDwide R Not supported
CapJrnDwideDhigh R Not supported
CapJrnEmptySensor R Not supported
CapJrnItalic R Not supported
CapJrnNearEndSensor R Not supported
CapJrnUnderline R Not supported
CapJrnCartridgeSensor R Not supported
CapJrnColor R Not supported
CapRecPresent R TRUE Receipt is possible.
CapRec2Color R TRUE 2-color printing is possible.
(Using paper printable in 2 colors)
CapRecBarCode R Not supported
CapRecBitmap R TRUE: Bitmap printing is possible.
CapRecBold R TRUE: Bold attribute setting is possible.
CapRecDhigh R TRUE: Double height attribute setting ispossible.
CapRecDwide R TRUE: Double width setting is possible.CapRecDwideDhigh R TRUE: Quadruple attribute setting ispossible.
CapRecEmptySensor R TRUE: Paper-Out sensor is active.FALSE: Paper-Out sensor is non-active.
CapRecItalic R Not supported
CapRecLeft90 R Not supported
CapRecNearEndSensor R TRUE: With Paper Near-End sensor
CapRecPapercut R Only partial cut (90) is supported.
CapRecRight90 R Not supported
CapRecRotate180 R Not supported
CapRecStamp R Not supported
CapRecUnderline R TRUE: Underline attribute setting is
possible.CapRecCartridgeSensor R PTR_CART_OK
CapRecColor R PTR_CUSTOM_COLOR1
CapRecMarkFeed R PTR_MF_TO_CUTTER
CapRecPageMode R Not supported
CapRecRuledLine R Not supported
CapSlpPresent R Not supported
CapSlpFullsl