English site 日本語サイト

*** Select OS(Language) *** Android(Java) iOS(Swift) iOS(Objective-C) Windows Desktop(C#) UWP(C#)

About this Manual

This manual is designed to help you understand StarPRNT SDK application. It is important to understand the basics of the application language.

There are SDKs available for many different operating systems and programming languages at our Global Support Site. Check the Developers Section of our site for the newest SDKs, technical documentation, FAQs, and many more additional resources.

• The information in this manual is subject to change without notice.

• STAR MICRONICS CO., LTD. has taken every measure to provide accurate information, but assumes no liability for errors or omissions.

• STAR MICRONICS CO., LTD. is not liable for any damages resulting from the use of information contained in this manual.

• Reproduction in whole or in part is prohibited.

• For the owners’ trademarks mentioned in this document, see Trademarks .

• 1. Getting Started
  • 1.1. Operating System
  • 1.2. Interface
  • 1.3. Printer
  • 1.4. Supported Peripherals
  • 1.5. Connecting a printer to a Device
    • 1.5.1. Bluetooth Interface
    • 1.5.2. Ethernet Interface
    • 1.5.3. Wireless LAN Interface
  • 1.6. Utility/Driver
• 2. How to add the library
  • 2.1. Adding the library to project
    • 2.1.1. Use Nuget package
    • 2.1.2. Manually adding the link
  • 2.2. Edit Package.appxmanifest
• 3. API Reference ( StarIOPort.winmd )
  • 3.1. Port
    • 3.1.1. HoldPrintTimeout
    • 3.1.2. Port
    • 3.1.3. ConnectAsync
    • 3.1.4. Close
    • 3.1.5. WriteAsync
    • 3.1.6. ReadAsync
    • 3.1.7. GetParsedStatusAsync
    • 3.1.8. GetOnlineStatusAsync
    • 3.1.9. BeginCheckedBlockAsync
    • 3.1.10. EndCheckedBlockAsync
    • 3.1.11. GetFirmwareInformationAsync
  • 3.2. ProductId
  • 3.3. ProductInformation
    • 3.3.1. FindAllAsync
    • 3.3.2. Name
    • 3.3.3. MacAddress
    • 3.3.4. ProductId
  • 3.4. ProductInformationCollection
  • 3.5. Status
  • 3.6. Util
    • 3.6.1. GetStarIOVersion
  • 3.7. FirmwareInformation
  • 3.8. PrinterInterfaceType
  • 3.9. StarBluetoothManager
    • 3.9.1. Bluetooth setting change flow using StarBluetoothManager
    • 3.9.2. StarDeviceType
    • 3.9.3. StarBluetoothSecurity
    • 3.9.4. StarBluetoothSettingCapability
    • 3.9.5. DeviceNameCapability
    • 3.9.6. BluetoothDeviceName
    • 3.9.7. iOSPortNameCapability
    • 3.9.8. iOSPortName
    • 3.9.9. PinCodeCapability
    • 3.9.10. PinCode
    • 3.9.11. AutoConnectCapability
    • 3.9.12. AutoConnect
    • 3.9.13. SecurityTypeCapability
    • 3.9.14. SecurityType
    • 3.9.15. PortName
    • 3.9.16. PortSettings
    • 3.9.17. Timeout
    • 3.9.18. DeviceType
    • 3.9.19. isOpened
    • 3.9.20. StarBluetoothManager
    • 3.9.21. ConnectAsync
    • 3.9.22. LoadSettingAsync
    • 3.9.23. DisconnectAsync
    • 3.9.24. ApplyAsync
  • 3.10. StarResultCode
• 4. API Reference ( StarIO_Extension.winmd )
  • 4.1. StarIoExt
    • 4.1.1. Emulation
    • 4.1.2. CharacterCode
    • 4.1.3. BcrModel
    • 4.1.4. DisplayModel
    • 4.1.5. MelodySpeakerModel
    • 4.1.6. CreateCommandBuilder
    • 4.1.7. CreateDisplayCommandBuilder
    • 4.1.8. CreateMelodySpeakerCommandBuilder
    • 4.1.9. CreateBcrConnectParser
    • 4.1.10. CreateDisplayConnectParser
    • 4.1.11. CreateMelodySpeakerConnectParser
  • 4.2. ICommandBuilder
    • 4.2.1. InitializationType
    • 4.2.2. FontStyleType
    • 4.2.3. CodePageType
    • 4.2.4. InternationalType
    • 4.2.5. LogoSize
    • 4.2.6. AlignmentPosition
    • 4.2.7. CutPaperAction
    • 4.2.8. PeripheralChannel
    • 4.2.9. SoundChannel
    • 4.2.10. BarcodeSymbology
    • 4.2.11. BarcodeWidth
    • 4.2.12. Pdf417Level
    • 4.2.13. QrCodeModel
    • 4.2.14. QrCodeLevel
    • 4.2.15. BitmapConverterRotation
    • 4.2.16. BlackMarkType
    • 4.2.17. LabelType
    • 4.2.18. PrintableAreaType
    • 4.2.19. CjkUnifiedIdeographFont
    • 4.2.20. HoldPrintType
    • 4.2.21. PaperPresentStatusType
    • 4.2.22. BaseMagnificationType
    • 4.2.23. BeginDocument
    • 4.2.24. EndDocument
    • 4.2.25. AppendInitialization
    • 4.2.26. AppendData
    • 4.2.27. AppendRawData
    • 4.2.28. AppendFontStyle
    • 4.2.29. AppendCodePage
    • 4.2.30. AppendInternational
    • 4.2.31. AppendLineFeed
    • 4.2.32. AppendUnitFeed
    • 4.2.33. AppendCharacterSpace
    • 4.2.34. AppendLineSpace
    • 4.2.35. AppendTopMargin
    • 4.2.36. AppendEmphasis
    • 4.2.37. AppendInvert
    • 4.2.38. AppendMultiple
    • 4.2.39. AppendUnderLine
    • 4.2.40. AppendLogo
    • 4.2.41. AppendAbsolutePosition
    • 4.2.42. AppendAlignment
    • 4.2.43. AppendHorizontalTabPosition
    • 4.2.44. AppendCutPaper
    • 4.2.45. AppendPeripheral
    • 4.2.46. AppendSound
    • 4.2.47. AppendBarcodeData
    • 4.2.48. AppendBarcodeDataWithAbsolutePosition
    • 4.2.49. AppendBarcodeDataWithAlignment
    • 4.2.50. AppendPdf417Data
    • 4.2.51. AppendPdf417DataWithAbsolutePosition
    • 4.2.52. AppendPdf417DataWithAlignment
    • 4.2.53. AppendQrCodeData
    • 4.2.54. AppendQrCodeDataWithAbsolutePosition
    • 4.2.55. AppendQrCodeDataWithAlignment
    • 4.2.56. AppendBitmapAsync
    • 4.2.57. AppendBitmapWithAbsolutePositionAsync
    • 4.2.58. AppendBitmapWithAlignmentAsync
    • 4.2.59. AppendBlackMark
    • 4.2.60. AppendLabel
    • 4.2.61. BeginPageMode
    • 4.2.62. EndPageMode
    • 4.2.63. AppendPageModeVerticalAbsolutePosition
    • 4.2.64. AppendPageModeRotation
    • 4.2.65. AppendPrintableArea
    • 4.2.66. AppendCjkUnifiedIdeographFont
    • 4.2.67. AppendHoldPrint
    • 4.2.68. AppendPaperPresentStatus
    • 4.2.69. AppendTextBaseMagnification
    • 4.2.70. GetCommands
  • 4.3. PageModePrintRegion
    • 4.3.1. PageModePrintRegion
  • 4.4. IDisplayCommandBuilder
    • 4.4.1. DisplayInternationalType
    • 4.4.2. DisplayCodePageType
    • 4.4.3. DisplayCursorMode
    • 4.4.4. DisplayContrastMode
    • 4.4.5. PassThroughCommands
    • 4.4.6. AppendData
    • 4.4.7. AppendBackSpace
    • 4.4.8. AppendHorizontalTab
    • 4.4.9. AppendLineFeed
    • 4.4.10. AppendCarriageReturn
    • 4.4.11. AppendBitmapAsync
    • 4.4.12. AppendInternational
    • 4.4.13. AppendCodePage
    • 4.4.14. AppendDeleteToEndOfLine
    • 4.4.15. AppendClearScreen
    • 4.4.16. AppendHomePosition
    • 4.4.17. AppendTurnOn
    • 4.4.18. AppendSpecifiedPosition
    • 4.4.19. AppendCursorMode
    • 4.4.20. AppendContrastMode
    • 4.4.21. AppendUserDefinedCharacter
    • 4.4.22. AppendUserDefinedDbcsCharacter
    • 4.4.23. GetCommands
  • 4.5. IMelodySpeakerCommandBuilder
    • 4.5.1. MelodySpeakerSoundStorageArea
    • 4.5.2. Commands
    • 4.5.3. AppendSound
    • 4.5.4. AppendSoundData
  • 4.6. SoundSetting
    • 4.6.1. Constants
    • 4.6.2. SoundStorageArea
    • 4.6.3. SoundNumber
    • 4.6.4. Volume
    • 4.6.5. Count
    • 4.6.6. Delay
    • 4.6.7. Interval
  • 4.7. IPeripheralCommandParser
    • 4.7.1. ParseResult
    • 4.7.2. CreateSendCommands
    • 4.7.3. Parse
  • 4.8. IPeripheralConnectParser
    • 4.8.1. isConnected
  • 4.9. StarIoExtManager
    • 4.9.1. StarIoExtManagerType
    • 4.9.2. StarIoExtManagerPrinterStatus
    • 4.9.3. StarIoExtManagerPrinterPaperStatus
    • 4.9.4. StarIoExtManagerPrinterCoverStatus
    • 4.9.5. StarIoExtManagerCashDrawerStatus
    • 4.9.6. StarIoExtManagerBarcodeReaderStatus
    • 4.9.7. Port
    • 4.9.8. PrinterOnlineStatus
    • 4.9.9. PrinterPaperStatus
    • 4.9.10. PrinterCoverStatus
    • 4.9.11. CashDrawerStatus
    • 4.9.12. BarcodeReaderStatus
    • 4.9.13. CashDrawerOpenActiveHigh
    • 4.9.14. StarIoExtManager
    • 4.9.15. ConnectAsync
    • 4.9.16. DisconnectAsync
    • 4.9.17. LockAsync
    • 4.9.18. PrinterImpossibleEvent
    • 4.9.19. PrinterOnlineEvent
    • 4.9.20. PrinterOfflineEvent
    • 4.9.21. PrinterPaperReadyEvent
    • 4.9.22. PrinterPaperNearEmptyEvent
    • 4.9.23. PrinterPaperEmptyEvent
    • 4.9.24. PrinterCoverOpenEvent
    • 4.9.25. PrinterCoverCloseEvent
    • 4.9.26. CashDrawerOpenEvent
    • 4.9.27. CashDrawerCloseEvent
    • 4.9.28. BarcodeReaderImpossibleEvent
    • 4.9.29. BarcodeReaderConnectEvent
    • 4.9.30. BarcodeReaderDisconnectEvent
    • 4.9.31. BarcodeDataReceivedEvent
    • 4.9.32. AccessoryConnectSuccessEvent
    • 4.9.33. AccessoryConnectFailureEvent
    • 4.9.34. AccessoryDisconnectEvent
    • 4.9.35. StatusUpdatedEvent
  • 4.10. StarBluetoothManagerFactory
    • 4.10.1. GetManager
• 5. API Reference ( StarIODeviceSetting.dll )
  • 5.1. StarNetworkManager
    • 5.1.1. StarNetworkManager
    • 5.1.2. LoadAsync
    • 5.1.3. ApplyAsync
  • 5.2. StarNetworkSetting
    • 5.2.1. StarNetworkSetting
    • 5.2.2. SteadyLan
  • 5.3. SteadyLanSetting
  • 5.4. StarIODeviceSettingException
• 6. Appendix
  • 6.1. ICommandBuilder Migration Guide (A Function Incorporated in the StarPRNT V5)
    • 6.1.1. Required Work Contents
    • 6.1.2. Implement StarIOExtension
    • 6.1.3. How to change API and command creation method (Introduction of ICommandBuilder)
    • 6.1.4. How to add a printer model
    • 6.1.5. Code flow from command creation to data transmission
  • 6.2. The printer model names included in the ProductInformation
  • 6.3. Data format for Code128 Barcode
    • 6.3.1. General Description of Code 128 BarCodes
    • 6.3.2. Characters printable with each code set
  • 6.4. Printing Data Creation Guide for mC-Label2