BIXOLON SPP-R200 Reference Manual
BIXOLON SPP-R200 Reference Manual

BIXOLON SPP-R200 Reference Manual

Windows sdk api reference guide
Hide thumbs Also See for SPP-R200:

Advertisement

Windows SDK API Reference Guide

Mobile Printer

Rev. 1.10
http://www.bixolon.com
SPP-R200
SPP-R210
SPP-R200II
SPP-R300
SPP-R400

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the SPP-R200 and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Summary of Contents for BIXOLON SPP-R200

  • Page 1: Mobile Printer

    Windows SDK API Reference Guide Mobile Printer Rev. 1.10 SPP-R200 SPP-R210 SPP-R200II SPP-R300 SPP-R400 http://www.bixolon.com...
  • Page 2: Table Of Contents

    Mobile Printer ■ Table of Contents 1. Manual Information ......................3 1-1 Supporting O/S & Platform..................3 1-2 Supporting Devices ..................... 3 2. Properties ........................4 2-1 CharacterSet (LONG R/W) ..................4 2-2 International CharacterSet (LONG R/W) ..............5 2-3 State (LONG R) ......................6 2-4 PowerValue (LONG R) ....................
  • Page 3: Manual Information

    This SDK Manual provides information on the dll files required for Windows application program development. We at BIXOLON maintain ongoing efforts to enhance and upgrade the functions and quality of all our products. In following, product specifications and/or user manual content may be changed without prior notice.
  • Page 4: Properties

    Mobile Printer 2. Properties The constant values used in the dll files provided are declared in the bxlconst.h file. The development environment was based on C++. 2-1 CharacterSet (LONG R/W) As the attribute that defines the Code Page of the printer, the default setting is BXL_CS_437.
  • Page 5: International Characterset (Long R/W)

    Mobile Printer 2-2 International CharacterSet (LONG R/W) As the attribute that defines the International Character Set of the printer, the default setting is BXL_ICS_USA. Use the SetInterChrSet(), GetInterChrSet()functions to set values or recall previously set values. The International Character Sets that can be used are as follows. Code Value Description...
  • Page 6: State (Long R)

    Mobile Printer 2-3 State (LONG R) This attribute sets the printer State. It can only be read, and is automatically set when examining the printer State by using the CheckPrinter function. As State values can be set in duplication, each value can be confirmed via bit calculation. The values of this attribute can be recalled by using the GetState function.
  • Page 7: Powervalue (Long R)

    Mobile Printer 2-4 PowerValue (LONG R) This attribute sets the battery capacity value of the printer. It can only be read, and is set every time the status of the printer battery changes. The values of this attribute can be recalled by using the GetPowerValue function.
  • Page 8: Setmsrmsgmode (Bool W)

    Mobile Printer 2-5 SetMsrMsgMode (BOOL W) This function sets MSR Message capacity value of the printer. The default setting is FALSE. Use the SetMsrMsgMode() functions to set values. Defaut value is false. Capacity values are as follows: Code Value Description TRUE Disable MSR Message functions FALSE...
  • Page 9: Methods

    Mobile Printer 3. Methods The functions disclosed in the provided module are declared in the ExportFunc.h file. The development environment was based on C++. 3-1 PrinterOpen In order to use the module, this function is enabled. For PDA types with different In/Out ports, port settings for each are required.
  • Page 10: Printerclose

    Mobile Printer 3-2 PrinterClose This function disables the SDK module. Functions related to printing and MSR are no longer available for use. long PrinterClose(); [Parameters] None [Return Values] Code Value Description BXL_SUCCESS Returns after function success * Example long lResult; lResult = PrinterClose();...
  • Page 11: Printbarcode

    Mobile Printer 3-4 PrintBarcode This function supports the 1-dimension and 2-dimension barcode printing function. long PrintBarcode( PCHAR Data, long symbology, long Height, long Width, long Alignment, long TextPosition [Parameters] * Data [in] ANSI Code Data ending with null. Barcode data to be printed are conveyed. * symbology [in] Defines the barcode type.
  • Page 12 Mobile Printer * TextPosition [in] This value sets the print position of the barcode data. Two dimensional barcodes have only the BXL_BC_TEXT_NONE value. Code Value Description BXL_BC_TEXT_NONE Barcode data not printed BXL_BC_TEXT_ABOVE Barcode data printed above barcode BXL_BC_TEXT_BELOW Barcode data printed below barcode [Return Values] Code Value...
  • Page 13: Printtext

    Mobile Printer 3-5 PrintText This function supports the text printing function. long PrintText( LPCTSTR Data, long Alignment, long Attribute, long TextSize [Parameters] * Data [in] Unicode Data ending with null. Conveys the barcode data to be printed. * Alignment [in] This value sets the barcode alignment. Code Value Description...
  • Page 14 Returns after function success BXL_NOT_OPENED -101 Unable to open communication port BXL_WRITE_ERROR -300 Failure to transmit data * Example long lResult; lResult = PrinterOpen(“portinfo…”, 1000); …… PrintText("Bixolon Mobile Printer.\n", BXL_ALIGNMENT_LEFT, BXL_FT_DEFAULT, BXL_TS_0WIDTH | BXL_TS_0HEIGHT); …… Rev. 1.10 - 14 -...
  • Page 15: Printbitmap

    Mobile Printer 3-6 PrintBitmap This function prints image files. (Bmp, jpg, Gif) but standard ce o/s Only support bitmap format. long PrintBitmap ( LPCTSTR FileName, long Width, long Alignment, long Level [Parameters] * FileName [in] Expressed as a row of Unicode characters, the full path of the image file is set. * Width [in] This value is the width of the image file to be converted.
  • Page 16: Checkprinter

    Mobile Printer 3-7 CheckPrinter This function checks printer status(cover open, paper empty) and battery status. You can get the checked status info using GetStat() and GetPowerValue(). long CheckPrinter (); [Parameters] None [Return Values] Code Value Description BXL_SUCCESS Returns after function success BXL_NOT_OPENED -101 Unable to open communication port...
  • Page 17: Initializeprinter

    Mobile Printer 3-8 InitializePrinter This method cancels conditions previously set and initializes the printer to the conditions having existed at power on. long InitializePrinter(); [Parameters] None. [Return Values] Code Value Description BXL_SUCCESS Returns after function success BXL_STS_ERROR An error has occurred. BXL_NOT_OPENED -101 Unable to open communication port...
  • Page 18: Directio

    Mobile Printer 3-9 DirectIO This function can send and read data defined by the user. long DirectIO ( PCHAR Data, UINT uiWrite, PCHAR pRequet, UINT uiRead [Parameters] * PCHAR Data [in] Data to be sent to the printer, data is ANSI code * UINT uiWrite [in] Size of data to be sent to the printer * PCHAR pRequet...
  • Page 19: Msrreadready

    Mobile Printer 3-10 MsrReadReady This function switches the printer to MSR Ready status. Printing is not possible when in eady status. After returning via BXL_SUCCESS and if the State property is BXL_STS_MSR_READY, the standby status is deemed normal. long CheckPrinter (); [Parameters] None [Return Values]...
  • Page 20: Msrreadcancel

    Mobile Printer 3-11 MsrReadCancel This function deactivates the MSR Ready status of the printer. Long MsrReadCancel(); [Parameters] None [Return Values] Code Value Description BXL_SUCCESS Returns after function success BXL_NOT_OPENED -101 Unable to open communication port BXL_WRITE_ERROR -300 Failure to transmit data BXL_MSR_NOTREADY -602 Not in READY status...
  • Page 21: Msrreadtrack

    Mobile Printer 3-12 MsrReadTrack This function recalls MSR data. If the MSR is in read mode and BXL_MSR_DATAEMPTY is returned, the card has not yet been read in the MSR. Scanning the card in the MSR again can be tried, or the MSRReadCancel function can be used to cancel read mode. Long MsrReadTrack ( PCHAR Data1, PCHAR Data2,...
  • Page 22: Msrread1Track

    Mobile Printer 3-13 MsrRead1Track This function returns MSR 1 Track data. If the MSR is in read mode and ERROR Code is returned, the card has not yet been read by the MSR. Strip the card with the MSR again. MSRReadCancel function can be used to cancel read mode.
  • Page 23: Msrread2Track

    Mobile Printer 3-14 MsrRead2Track This function returns MSR 2 Track data. If the MSR is in read mode and ERROR Code is returned, the card has not yet been read by the MSR. Strip the card with the MSR again. MSRReadCancel function can be used to cancel read mode.
  • Page 24: Msrread3Track

    Mobile Printer 3-15 MsrRead3Track This function returns MSR 3 Track data. If the MSR is in read mode and ERROR Code is returned, the card has not yet been read by the MSR. Strip the card with the MSR again. MSRReadCancel function can be used to cancel read mode.
  • Page 25: Msrreadfulltrack

    Mobile Printer 3-16 MsrReadFullTrack This function returns MSR Full Track data. If the MSR is in read mode and ERROR Code is returned, the card has not yet been read by the MSR. Strip the card with the MSR again. MSRReadCancel function can be used to cancel read mode.
  • Page 26: Gettrack1

    Mobile Printer 3-17 GetTrack1 This function returns MSR Track1 data. If the MSR is in read mode and ERROR code is returned, the card has not yet been read by the MSR. Strip the card with the MSR again. MSRReadCancel function can be used to cancel read mode. long GetTrack1 (TCHAR* tcData, UINT dwLen);...
  • Page 27: Gettrack2

    Mobile Printer 3-18 GetTrack2 This function returns MSR Track2 data. If the MSR is in read mode and ERROR code is returned, the card has not yet been read by the MSR. Strip the card with the MSR again. MSRReadCancel function can be used to cancel read mode. long GetTrack2 (TCHAR* tcData, UINT dwLen);...
  • Page 28: Gettrack3

    Mobile Printer 3-19 GetTrack3 This function returns MSR Track3 data. If the MSR is in read mode and ERROR code is returned, the card has not yet been read by the MSR. Strip the card with the MSR again. MSRReadCancel function can be used to cancel read mode. long GetTrack3 (TCHAR* tcData, UINT dwLen);...
  • Page 29: Selectmode

    Mobile Printer 3-20 SelectMode This method selects label or receipt mode. long SelectMode(BOOL bLabelMode) [Parameters] * BOOL bLabelMode [in] Use or not use Label Mode if this value is true, label mode is selected. Otherwise receipt mode is selected. [Return Values] Code Value Description...
  • Page 30: Nextprintpos

    Mobile Printer 3-21 NextPrintPos If the label function is set, the paper is fed up to the next printing position. Long NextPrintPos (); [Parameters] None [Return Values] Code Value Description BXL_SUCCESS Returns after function success BXL_NOT_OPENED -101 Unable to open communication port BXL_NOT_SUPPORT -107 Printer is not label mode...
  • Page 31: Autocalibration

    Mobile Printer 3-22 AutoCalibration This method executes auto calibration in label mode. long AutoCalibration() [Parameters] None [Return Values] Code Value Description BXL_SUCCESS Returns after function success BXL_STS_ERROR An error has occurred. BXL_NOT_OPENED -101 Unable to open communication port BXL_WRITE_ERROR -300 Failure to transmit data * Example long lResult;...
  • Page 32: Selectpagemode

    Mobile Printer 3-23 SelectPageMode This command switches standard mode and page mode. long SelectPageMode(BOOL bPageMode) [Parameters] * BOOL bLabelMode [in] Use or not use page mode if this value is ture, page mode is selected. Otherwise standard mode is selected. [Return Values] Code Value...
  • Page 33: Formfeed

    Mobile Printer 3-24 FormFeed This method prints all data collected in the printer buffer In page mode. After completion of printing, the printer is returned to standard mode. long FormFeed(long nFeed) [Parameters] * long nFeed [in] the number of form feed to execute. [Return Values] Code Value...
  • Page 34: Setprintareainpm

    Mobile Printer 3-25 SetPrintAreaInPM This function sets the position and the size of the printing area in page mode as following. long SetPrintAreaInPM(long x, long y, long width, long height) [Parameters] * long x [in] Horizontal starting position * long y [in] Vertical starting position * long width [in] Horizontal printing area width...
  • Page 35: Setprintdirectioninpm

    Mobile Printer 3-26 SetPrintDirectionInPM This method selects the print direction and starting position in page mode. long SetPrintDirectionInPM(long printDirection) [Parameters] * long printDirection [in] This value sets the print position. printDirection Value Print Direction Starting Position Rotaion BXL_PD_LEFT_TO_RIGHT Left -> Right Upper left 0-degree BXL_PD_BOTTOM_TO_TOP...
  • Page 36: Setverticalpositioninpm

    * Example long lResult; lResult = PrinterOpen(“portinfo…”, 1000); …… // Select Page Mode if (SelectPageMode(true) != BXL_SUCCESS) return; SetPrintAreaInPM(0, 0, 416, 416); SetPrintDirectionInPM(BXL_PD_LEFT_TO_RIGHT); SetVerticalPositionInPM(160); SetHorizontalPositionInPM(40); PrintText(“Bixolon Mobile Printer.”, 0, BXL_FT_DEFAULT, BXL_TS_0WIDTH | BXL_TS_0HEIGHT); …… PrintDataInPageMode(); FormFeed(2); Rev. 1.10 - 36 -...
  • Page 37: Sethorizontalpositioninpm

    * Example long lResult; lResult = PrinterOpen(“portinfo…”, 1000); …… // Select Page Mode if (SelectPageMode(true) != BXL_SUCCESS) return; SetPrintAreaInPM(0, 0, 416, 416); SetPrintDirectionInPM(BXL_PD_LEFT_TO_RIGHT); SetVerticalPositionInPM(160); SetHorizontalPositionInPM(40); PrintText(“Bixolon Mobile Printer.”, 0, BXL_FT_DEFAULT, BXL_TS_0WIDTH | BXL_TS_0HEIGHT); …… PrintDataInPageMode(); FormFeed(2); Rev. 1.10 - 37 -...
  • Page 38: Printdatainpagemode

    * Example long lResult; lResult = PrinterOpen(“portinfo…”, 1000); …… // Select Page Mode if (SelectPageMode(true) != BXL_SUCCESS) return; SetPrintAreaInPM(0, 0, 416, 416); SetPrintDirectionInPM(BXL_PD_LEFT_TO_RIGHT); SetVerticalPositionInPM(160); SetHorizontalPositionInPM(40); PrintText(“Bixolon Mobile Printer.”, 0, BXL_FT_DEFAULT, BXL_TS_0WIDTH | BXL_TS_0HEIGHT); …… PrintDataInPageMode(); FormFeed(2); Rev. 1.10 - 38 -...
  • Page 39: Message

    Mobile Printer 4. Message If some events have occurred in printer, the SDK will send WM_MSR_ARRIVED (WM_USER+3) message. 4-1 BXL_LPARAM _MSR This message will be posted when the printer reads MSR Track data from MSR sensor. lParam lParam is set by the following data. Value Description BXL_MSG_TRACK1...

This manual is also suitable for:

Spp-r210Spp-r400Spp-r200iiSpp-r300

Table of Contents