Zebra ZXP Series 1 Card Printer Card Printer Encoding over Ethernet Software Developer Reference Manual (en)
Zebra Card
Printer
Encoding over Ethernet
Software Developer
Reference Manual
P1103866-001
Copyright
© 2018 ZIH Corp. and/or its aliates. All rights reserved. ZEBRA and the stylized Zebra head are trademarks
of ZIH Corp., registered in many jurisdictions worldwide. All other trademarks are the property of their respective
owners.
COPYRIGHTS & TRADEMARKS: For complete copyright and trademark information, go to: www.zebra.com/
copyright
WARRANTY: For complete warranty information, go to: www.zebra.com/warranty
END USER LICENSE AGREEMENT: For complete EULA information, go to: www.zebra.com/eula
Terms of Use
Proprietary Statement This manual contains proprietary information of Zebra Technologies Corporation and
its subsidiaries (“Zebra Technologies”). It is intended solely for the information and use of parties operating and
maintaining the equipment described herein. Such proprietary information may not be used, reproduced, or
disclosed to any other parties for any other purpose without the express, written permission of Zebra Technologies.
Product Improvements Continuous improvement of products is a policy of Zebra Technologies. All specications
and designs are subject to change without notice.
Liability Disclaimer Zebra Technologies takes steps to ensure that its published Engineering specications and
manuals are correct; however, errors do occur. Zebra Technologies reserves the right to correct any such errors and
disclaims liability resulting therefrom.
Limitation of Liability In no event shall Zebra Technologies 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, consequential damages including loss of business prots, business interruption, or loss
of business information) arising out of the use of, the results of use of, or inability to use such product, even if Zebra
Technologies has been advised of the possibility of such damages. Some jurisdictions do not allow the exclusion or
limitation of incidental or consequential damages, so the above limitation or exclusion may not apply to you.
Contents
Introduction ....................................................................................................................................................................1
Required Skills...............................................................................................................................................................1
SDK Elements ...............................................................................................................................................................1
Overview........................................................................................................................................................................2
ZBRSXBridge ................................................................................................................................................................3
ZBRSXClose ....................................................................................................................................................3
ZBRSXDiscover ...............................................................................................................................................4
ZBRSXUSBEnumEx ........................................................................................................................................5
ZBRSXConnect ................................................................................................................................................6
ZBRSXDisconnect ...........................................................................................................................................7
ZBRSXGetStatus .............................................................................................................................................8
ZBRSXGetPCSCReaderNames .......................................................................................................................9
Using ZBRSXBridge ....................................................................................................................................................11
Introduction .....................................................................................................................................................11
DLL Loader .....................................................................................................................................................12
DLL Importer ...................................................................................................................................................12
ZBRSXBridge Methods ...................................................................................................................................13
ZBRSXCLOSE ....................................................................................................................................13
ZBRSXDiscover ..................................................................................................................................13
ZBRSXUSBEnumEx ...........................................................................................................................13
ZBRSXConnect ..................................................................................................................................14
ZBRSXDisconnect ..............................................................................................................................14
ZBRSXGetStatus ................................................................................................................................14
ZBRSXGetPCSCReaderName ...........................................................................................................15
Example Code: ...................................................................................................................................16
Error Codes .................................................................................................................................................................17
Error Codes and Descriptions .........................................................................................................................17
i
ii
Encoding over Ethernet
Introduction
This manual contains information for software developers to write applications for Zebra card printers which require
smartcard encoding via an Ethernet connection.
The purpose of the Encoding over Ethernet (EoE) SDK—ZBRSXBridge.dll—is to create the required communication
interface between a software application and the smartcard module in a Zebra card printer.
Required Skills
y Experience in developing applications for the Microsoft Windows environment
y Experience in developing applications using dynamic link libraries (DLL)
SDK Elements
ZBRSXBridge.dll
y Provides the actual EoE API.
y It is written in Microsoft’s C language
y Available as a 32 bit & 64 bit dynamic link library
Sxuptp.dll (Silex)
y Provides the interface to the required device driver
y It is written in Microsoft C language
y Available as a 32- and 64-bit dynamic link library
Sxuptp.sys (Silex)
y Device driver
y Required to be installed in the OS prior to using the SDK
y Available as 32- and 64-bit
Each of the DLLs should be placed in the same directory as the application which uses them.
The device driver should be installed using the supplied installation program.
1
Overview
Encoding over Ethernet is a two-step process: A virtual USB connection is created between a host (PC) and the
smartcard module within a Zebra card printer over Ethernet. Once this connection is established, an additional
connection is created between a software application and the smartcard to be encoded which remains active during
the entire encoding process.
For UHF smartcards to be encoded, the Zebra SmartCard SDK and ZBRSCReader.dll will be required to
communicate with the UHF cards. For encoding PC/SC compliant smartcards, the PC/SC SDK available within the
operating system in use will be needed. Each of these SDKs is used following the establishment of the virtual USB
connection.
2
ZBRSXBridge
ZBRSXClose
Description: Closes the SDK.
Syntax: int ZBRSXClose(
out int errorCode)
Parameters: errorCode [out] error code; see Appendix A
Return: 0 = function failed. See error code for details
1 = function succeeded
Example:
int errorCode = 0;
int result = ZBRSXClose(out errorCode);
3
Loading...