Zebra ZQ110 Mobile Printer ZQ110 Windows SDK API Reference Guide (en)

P1069074-001 Rev. 1.01
ZQ110
API Reference Guide
ZQ110
Rev. 1.01
- 2 -
Mobile Printer Windows SDK API Reference Guide
Table of Contents
1. MANUAL INFORMATION ............................................................................................................................. 6
1-1 SUPPORTED OPERATING SYSTEM (OS) & PLATFORM ................................................................................... 6
1-2 SUPPORTING DEVICES ................................................................................................................................ 6
2. PROPERTIES ................................................................................................................................................ 7
2-1 CHARACTERSET (LONG R/W) ................................................................................................................... 7
2-2 INTERNATIONAL CHARACTERSET (LONG R/W) ........................................................................................... 8
2-3 STATE (LONG R) ....................................................................................................................................... 8
2-4 POWERVALUE (LONG R) ........................................................................................................................... 9
2-5 MSRMSGMODE (BOOL W) ........................................................................................................................ 9
3. METHODS ................................................................................................................................................... 10
3-1 PRINTEROPEN ......................................................................................................................................... 10
3-2 PRINTERCLOSE ......................................................................................................................................... 11
3-3 LINEFEED ................................................................................................................................................. 11
3-4 PRINTBARCODE ....................................................................................................................................... 12
3-5 PRINTTEXT .............................................................................................................................................. 14
3-6 PRINTBITMAP ........................................................................................................................................... 16
3-7 CHECKPRINTER ....................................................................................................................................... 17
3-8 MSRREADREADY ..................................................................................................................................... 17
3-9 MSRREADCANCEL ................................................................................................................................... 18
3-10 MSRREADTRACK ................................................................................................................................... 18
3-11 DIRECTIO .............................................................................................................................................. 19
3-12 NEXTPRINTPOS ..................................................................................................................................... 20
3-13 GETTRACK1 .......................................................................................................................................... 20
3-14 GETTRACK2 .......................................................................................................................................... 20
3-15 GETTRACK3 .......................................................................................................................................... 21
3-16 MSRREADFULLTRACK ............................................................................................................................ 21
3-17 MSRREAD1TRACK ................................................................................................................................. 22
3-18 MSRREAD2TRACK ................................................................................................................................. 22
3-19 MSRREAD3TRACK ................................................................................................................................. 23
4. MESSAGE ................................................................................................................................................... 24
4-1 SETMSRMSGMODE(BOOL BVALUE) ......................................................................................................... 24
4-2 BXL_LPARAM _MSR ............................................................................................................................. 25
ZQ110
Rev. 1.01
- 3 -
Mobile Printer Windows SDK API Reference Guide
Proprietary Statements
This manual contains proprietary information for Zebra Technologies Corporation. It is intended solely for the information and use of parties operating and maintaining the equip­ment described herein. Such proprietary information may not be used, reproduced, or dis­closed to any other parties for any other purpose without the expressed written permission of Zebra Technologies Corporation.
Product Improvements Since continuous product improvement is a policy of Zebra Technologies Corporation, all specifications and signs are subject to change without notice.
FCC Compliance Statement NOTE: This equipment has been tested and found to comply with the limits of a Class B digital device, pursuant to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation. This equip­ment generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference with radio communications. However, there is no guarantee that interference will not occur in a particular installation. If this equipment does cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures:
• Reorient or relocate the receiving antenna.
• Increase the separation between the equipment and the receiver.
• Connect the equipment to an outlet or circuit different from that to which the receiver is
connected.
• Consult the dealer or an experienced radio/TV technician for help.
WARNING: Exposure to Radio Frequency radiation. To conform to FCC RF exposure re­quirements this device shall be used in accordance with the operating conditions and in­structions listed in this manual. NOTE: This unit was tested with shielded cables on the peripheral devices. Shielded cables must be used with the unit to ensure compliance. Changes or modifications to this unit not expressly approved by Zebra Technologies Corporation could void the user’s authority to operate this equipment.
ZQ110
Rev. 1.01
- 4 -
Mobile Printer Windows SDK API Reference Guide
Canadian Compliance Statement
This Class B digital apparatus complies with Canadian ICES-003. Cet appareil numérique de la classe B est conforme á la norme NMB-003 du Canada. “IC:” before the equipment certification number signifies that the Industry Canada technical specifications were met. It does not guarantee that the certified product will operate to the user’s satisfaction.
Liability Disclaimer Inasmuch as every effort has been made to supply accurate information in this manual, Zebra Technologies Corporation is not liable for any erroneous information or omissions. Zebra Technologies Corporation reserves the right to correct any such errors and disclaims liability resulting therefrom.
No Liability for Consequential Damage In no event shall Zebra Technologies Corporation or anyone else involved in the creation, production, or delivery of the accompanying product (including hardware and software) be liable for any damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or other pecuniary loss) arising out of the use of or the results of use of or inability to use such product, even if Zebra Technologies Corporation has been advised of the possibility of such damages. Because some states do not allow the exclusion of liability for consequential or incidental damages, the above limitation may not apply to you.
ZQ110
Rev. 1.01
- 5 -
Mobile Printer Windows SDK API Reference Guide
Copyrights
The copyrights in this manual and the label print engine described therein are owned by Zebra Technologies Corporation. Unauthorized reproduction of this manual or the software in the label print engine may result in imprisonment of up to one year and fines of up to $10,000 (17 U.S.C.506). Copyright violators may be subject to civil liability. This product may contain ZPL®, ZPL II®, and ZebraLink programs; Element Energy Equalizer® Circuit; E3®; and AGFA fonts. Software © ZIH Corp. All rights reserved worldwide. ZebraLink and all product names and numbers are trademarks, and Zebra, the Zebra logo, ZPL, ZPL II, Element Energy Equalizer Circuit, and E3 Circuit are registered trademarks of ZIH Corp. All rights reserved worldwide. Monotype®, Intellifont® and UFST® are trademarks of Monotype Imaging, Inc. registered in the United States Patent and Trademark Office and may be registered in certain jurisdictions. Andy, CG Palacio, CG Century Schoolbook, CG Triumvirate, CG Times, Monotype Kai, Monotype Mincho and Monotype Sung are trademarks of Monotype Imaging, Inc. and may be registered in some jurisdictions. HY Gothic Hangul is a trademark of Hanyang Systems, Inc. Angsana is a trademark of Unity Progress Company (UPC) Limited. Andale®, Arial®, Book Antiqua®, Corsiva®, Gill Sans®, Sorts® and Times New Roman® are trademarks of The Monotype Corporation registered in the United States Patent and Trademark Office and may be registered in certain jurisdictions. Century Gothic™, Bookman Old Style™ and Century Schoolbook are trademarks of The Monotype Corporation and may be registered in certain jurisdictions. HGPGothicB is a trademark of the Ricoh company, Ltd. and may be registered in some jurisdictions. Univers is a trademark of Heidelberger Druckmaschinen AG, which may be registered in certain jurisdictions, exclusively licensed through Linotype Library GmbH, a wholly owned subsidiary of Heidelberger Druckmaschinen AG. Futura® is a trademark of Bauer Types SA registered in the United States Patent and Trademark Office and may be registered in some jurisdictions. TrueType® is a trademark of Apple Computer, Inc. registered in the United States Patent and Trademark Office and may be registered in certain jurisdictions. All other product names are the property of their respective owners. All other brand names, product names, or trademarks belong to their respective holders. ©2014 ZIH Corp.
ZQ110
Rev. 1.01
- 6 -
Mobile Printer Windows SDK API Reference Guide
1. Manual Information
This SDK Manual provides information on the dll files required for Windows application program development.
1-1 Supported Operating System (OS) & Platform
Supported OS:
Microsoft Windows CE 5.x Microsoft Windows XP Microsoft Windows Vista Microsoft Windows 7 Microsoft Windows 8
Supported Platform:
Pocket PC 2002 Pocket PC 2003 Pocket PC 2003 second edition Windows Mobile 5 Windows Mobile 6 Custom Platform for Armv4i CPU
* Supported .Net Framework
1-2 Supporting Devices
This is a list of verified devices. If your PDA CPU type is Armv4 or Armv4i, it is compatible with the module driver.
Bluebird BIP-6000 Widefly WF35 HP iPAQ 212
ZQ110
Rev. 1.01
- 7 -
Mobile Printer Windows SDK API Reference Guide
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. Use the SetCharacterSet(), GetCharacterSet() functions to set values or recall previously set values.
The Code Pages that can be used are as follows:
Code
Value
Description
BXL_CS_PC437 0 Code page PC437
BXL_CS_KATAKANA 1 Katakana
BXL_CS_PC850 2 Code page PC850
BXL_CS_PC860 3 Code page PC860
BXL_CS_PC863 4 Code page PC863
BXL_CS_PC865 5 Code page PC865
BXL_CS_WPC1252
16
Code page WPC1252
BXL_CS_PC866
17
Code page PC866
BXL_CS_PC852
18
Code page PC852
BXL_CS_PC858
19
Code page PC858
BXL_CS_PC864
22
Code page PC864
BXL_CS_THAI42
23
Code page THAI42
BXL_CS_WPC1253
24
Code page WPC1253
BXL_CS_WPC1254
25
Code page WPC1254
BXL_CS_WPC1257
26
Code page WPC1257
BXL_CS_FARSI
27
Code page Farsi
BXL_CS_WPC1251
28
Code page WPC1251
BXL_CS_PC737
29
Code page PC737
BXL_CS_PC775
30
Code page PC775
BXL_CS_THAI14
31
Code page THAI14
BXL_CS_PC862
33
Code page PC862
BXL_CS_PC855
36
Code page PC855
BXL_CS_PC857
37
Code page PC857
BXL_CS_PC928
38
Code page PC928
BXL_CS_THAI16
39
Code page THAI16
BXL_CS_WPC1256
40
Code page PC1256
BXL_CS_PC1258
41
Code page PC1258
BXL_CS_KHMER
42
Code page KHMER
BXL_CS_PC1250
47
Code page PC1250
BXL_CS_LATIN9
48
Code page Latin 9
BXL_CS_USER
255
User set page
ZQ110
Rev. 1.01
- 8 -
Mobile Printer Windows SDK API Reference Guide
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
BXL_ICS_USA 0 USA code setting
BXL_ICS_FRANCE
1
FRANCE code setting
BXL_ICS_GERMANY
2
GERMANY code setting
BXL_ICS_UK
3
UK code setting
BXL_ICS_DENMARK1
4
DENMARK1 code setting
BXL_ICS_SWEDEN
5
SWEDEN code setting
BXL_ICS_ITALY 6 ITALY code setting
BXL_ICS_SPAIN 7 SPAIN code setting
BXL_ICS_NORWAY
9
NORWAY code setting
BXL_ICS_DENMARK2
10
DENMARK 2 code setting
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. Note: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.
Printer State values are as follows:
Code
Value
Description
BXL_STS_NORMAL
0
Printer status is normal
BXL_STS_PAPEREMPTY
1
No paper in printer
BXL_STS_COVEROPEN
2
The printer paper cover is open
BXL_STS_POWEROVER
4
The printer battery capacity is insufficient
BXL_STS_MSR_READY
8
Currently in MSR read mode, printing not possible
BXL_STS_PRINTING
16
Currently printing or transmitting data
BXL_STS_ERROR
32
An error has occurred
BXL_STS_NOT_OPEN
64
The printer is not open
BXL_STS_ERROR_OCCUR
128
An error has occurred
Loading...
+ 17 hidden pages