Datacard® Windows XPS Driver

Software Development Kit

Programmer’s Reference Guide

November 2017

Part No. 527250-001, Rev. H

Notice
Please do not attempt to operate or repair this equipment without adequate training.
Any use, operation or repair you perform that is not in accordance with the information
contained in this documentation is at your own risk.

Trademark Acknowledgments
Datacard is a registered trademark and service mark of Entrust Datacard Corporation in
the United States and other countries.

Entrust is a registered trademark and service mark in the United States and other
countries.

MasterCard is a registered trademark of MasterCard International Incorporated.

Visa is a registered trademark of Visa International Service Association.

All other product names are the property of their respective owners.

Proprietary Notice
The design and information contained in these materials are protected by US and
international copyright laws.

All drawings and information herein are the property of Entrust Datacard Corporation. All
unauthorized use and reproduction is prohibited.

Entrust Datacard
1187 Park Place
Shakopee, MN 55379
Phone: 952-933-1223
Fax: 952-933-7971
www.entrustdatacard.com

Copyright © 2016, 2017 Entrust Datacard Corporation. All rights

reserved.

ii
Compliance Statements
Liability
The WARNING and CAUTION labels have been placed on the equipment for your safety. Please do
not attempt to operate or repair this equipment without adequate training. Any use, operation,
or repair in contravention of this document is at your own risk.

Safety
The following basic safety tips are given to ensure safe installation, operation, and maintenance
of Entrust Datacard™ equipment.
• Connect equipment to a grounded power source. Do not defeat or bypass the ground lead.
• Place the equipment on a stable surface (table) and ensure floors in the work area are dry and
non-slip.
• Know the location of equipment branch circuit interrupters or circuit breakers and how to turn
them on and off in case of emergency.
• Know the location of fire extinguishers and how to use them. ABC type extinguishers may be
used on electrical fires.
• Know local procedures for first aid and emergency assistance at the customer facility.
• Use adequate lighting at the equipment location.
• Maintain the recommended temperature and humidity range in the equipment area.

3
Regulatory Compliance
EMC Compliance Notice
To ensure compliance of the model RX10 retransfer printer to the radiated emissions
requirements for class “A” Information Technology Equipment, be sure to use a shielded Ethernet
cable when connecting to your network

Notice for USA (FCC Notice)

This equipment has been tested and found to comply with the limits for Class A computing
devices, pursuant to Part 15 of FCC rules. These limits are designed to provide reasonable
protection against harmful interference when the equipment is operated in a commercial
environment. This equipment generates, uses, and can radiate radio frequency energy. If this
equipment is not installed and used in accordance with this instruction manual, it may cause
harmful interference to radio communications. Operation of this equipment in a residential area
is likely to cause harmful interference in which case the user will be required to correct the
interference at their own expense. Changes or modifications not expressly approved by the party
responsible for compliance could void the user's authority to operate the equipment.

This device complies with Part 15 of the FCC Rules. Operation is subject to the following two
conditions: (1) This device may not cause harmful interference, and (2) this device must accept
any interference received, including interference that may cause undesired operation.

Notice for Canada

Industry Canada

This digital apparatus does not exceed the Class A limits for radio noise for digital apparatus set
out in the Radio Interference Regulations of the Canadian Department of Communications.

Le présent appareil numérique n'émet pas de bruits radioélectriques dépassant les limites
applicables aux appareils numériques de la classe A prescrites dans le Règlement sur le brouillage
radioélectrique édicté par le ministère des Communications du Canada.

RSS-Gen, Issue 3, December 2010, Section 7.1.3 User Manual Notice

This Device complies with Industry Canada License-exempt RSS standard(s). Operation is subject
to the following two conditions: 1) this device may not cause interference, and 2) this device
must accept any interference, including interference that may cause undesired operation of the
device.

Cet appareil est conforme avec Industrie Canada RSS standard exemptes de licence(s). Son
fonctionnement est soumis aux deux conditions suivantes: 1) ce dispositif ne peut causer des
interférences, et 2) cet appareil doit accepter toute interférence, y compris les interférences qui
peuvent causer un mauvais fonctionnement du dispositif.

4
Notice for Europe
The EU Declaration of Conformity can be found on EntrustDatacard.com under product
compliance.

WARNING: This is a class A product. This equipment is compliant with class A of either CISPR32 or
CISPR22. In a domestic/residential environment this equipment may cause radio interference, in
which case the user may be required to take adequate measures.

WEEE: The model RX10 retransfer printer uses a lithium coin cell battery. Refer to the service
manual for battery removal instructions.

Simplified EU Declaration of Conformity

Entrust Datacard Corporation declares that the following radio equipment: MXD, MX6000,
MX6100, PB6500, MX2000, MX2100, SP55k, SP35, SP55, CP40, CP60, CP80, SP75, FP65, SR200,
SR300, PX10, PX30, EX30, MPR3800, CR500f, MX1100, RX10, and PB1000 is in compliance with
the Directive 2014/53/EU.

Intentional Radiator Information

Effective Radiated
Description/Model Number FCC ID Frequency Power (ERP) mW

PX10 Supplies RFID GDI-Q20010 13.56MHz 9.16E-06

PX30 Supplies RFID GDI-Q30030 13.56MHz 9.16E-06

Central Issuance Supplies GDI-SID004 13.56MHz 1.96E-07

RFID

LX30, RX10 Supplies RFID GDI-506241001 13.56MHz 3.03E-05

EX30 Supplies RFID GDI-Q30130 13.56MHz 9.16E-06

FP65 Supplies RFID GDI-Q10055 13.56MHz 3.65E-05

Central Issuance Smartcard GDI-50543001 13.56MHz 1.45E-05

Coupler

EMC Compliance Notice:

For model RX10/Multi-hopper configurations, to ensure compliance with Conducted Immunity

standard EN61000-4-6, use USB cables no longer than three meters in length.

5
Notice for Australia
This is a Class A product. In a domestic environment this product may cause radio interference, in
which case the user may be required to take adequate measures.

Notice for China (Simplified Chinese)

ᙆ ѓ

Ϥ为 "
级产  d    ‫ ݺ‬环  ʕd
该产         ϓȭ线䕚ʍ f
ί这᮱ 䀒ɨd     
͜ 䔚
     f
Notice for Taiwan (Traditional Chinese)

Notice for Japan

Japanese Voluntary Control Council for Interference (VCCI) class A statement

Korea Communications Commission (KCC) statement

6
California Proposition 65 Compliance

WARNING: This product contains chemicals, including lead, known to the State of California to
cause cancer, and birth defects or other reproductive harm. Wash hands after handling.

Entrust Datacard believes that its products are not harmful when used as designed. However, the
above warning is made in compliance with the State of California Safe Drinking Water and Toxic
Enforcement Act of 1986, which requires warning labels on products that may contain elements
that the State of California considers harmful.

California Lithium Perchlorate Warning

Perchlorate Material - special handling may apply. See www.dtsc.ca.gov/hazardouswaste/
perchlorate.

This notice is required by California Code of Regulations, Title 22, Division 4.5, Chapter 33: Best
Management Practices for Perchlorate Materials. This product/part includes a battery that
contains Perchlorate material.

vii
viii
 Revision Log
Windows XPS Driver Software Development Kit
Programmer’s Reference Guide

Revision Date Description of Changes

A May 2012 First release of this document

B November 2012 Updates for XPS Card Printer Driver 4.0

C April 2013 Updates for XPS Card Printer Driver 4.1

D March 2014 Updates for XPS Card Printer Driver 5.0

E January 2015 Updates for XPS Card Printer Driver 6.0

F May 2015 Updates for XPS Card Printer Driver 6.1

G October 2015 Updates for XPS Card Printer Driver 6.2

H November 2017 Updates for XPS Card Printer Driver 7.2 and 7.3

ix
x
 Contents
Chapter 1: Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Chapter 2: SDK Sample Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Sample Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Samples Included in the SDK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Print Sample (Not Interactive) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Magnetic Stripe Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Smart Card Sample. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Bar Code Park Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Single-Wire Smart Card Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Single-Wire MIFARE Classic Smart Card Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Lamination Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Read and Verify Laminator Serialized Overlay Sample . . . . . . . . . . . . . . . . . . . . . . . . . 8
Emboss and Indent Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Laser Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Print Locking Sample. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Printer Control Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Printer State Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Status Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Sample Code Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Developer Environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Text Printing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Raster Graphics Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Vector Graphics Printing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Topcoat and Print Blocking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Controlling Card Printing Preferences. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Sample Code that Demonstrates Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Get the Status of a Print Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Embossing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Sample Code that Demonstrates Embossing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Laminating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Laminator Bar Code Read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Sample Code that Demonstrates Laminating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Laser Engraving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Sample Code that Demonstrates Laser Engraving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Chapter 3: Interactive Mode Using the IBidiSpl Interface . . . . . . . . . . . . . . . . . . . . . . . . 19

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
IBidiSpl Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Java Helper DLL Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

xi
Order and Timing of Interactive Job Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Determine the Success of an IBidiSpl Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Start and End an Interactive Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Sample Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Get the Status of an Interactive Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Sample Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Interactive Mode Error Recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Error-Related Values in the Printer Status Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Recovery from Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Basic Error Recovery (Recommended) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Advanced Error Recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Cancel All Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Errors Cleared at the Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Suppress the Driver Message Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Encode a Magnetic Stripe with Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Interactive Mode Magnetic Stripe Encoding. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Magnetic Stripe Track Data Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Sample Code—Magnetic Stripe Encode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Read Data From a Magnetic Stripe. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Sample Code—Magnetic Stripe Read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Place a Card in the Bar Code Reader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Read Data from a Serialized Laminate Bar Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Sample Code—Serialized Laminate Bar Code Read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Place a Card in the Smart Card Station . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Sample Code—Smart Card Park . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Personalize a Smart Card . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Printer.SmartCardUnit:SingleWire:Connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Smart Card Connect Request—Required Information. . . . . . . . . . . . . . . . . . . . . . . . . 40
Smart Card Connect Request—Return Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Smart Card Connect Request—Status Returned . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Printer.SmartCardUnit:SingleWire:Disconnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Smart Card Disconnect Request—Required Information . . . . . . . . . . . . . . . . . . . . . . 41
Smart Card Disconnect Request—Return Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Smart Card Disconnect Request—Status Returned . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Printer.SmartCardUnit:SingleWire:Transmit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Smart Card Transmit Request—Required Information . . . . . . . . . . . . . . . . . . . . . . . . . 43
Smart Card Transmit Request—Return Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Smart Card Transmit Request—Status Returned . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Printer.SmartCardUnit:SingleWire:Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Smart Card Status Request—Return Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Smart Card Status Request—Status Returned . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

xii
 Printer.SmartCardUnit:SingleWire:GetAttrib . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Smart Card GetAttrib Request—Required Information . . . . . . . . . . . . . . . . . . . . . . . . 45
Smart Card GetAttrib Request—Return Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Smart Card GetAttrib Request—Status Returned . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Sample Code—Single-Wire Smart Card Personalization . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Read and Write Data to MIFARE Classic over Single-Wire . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Sample Code—Single-Wire MIFARE Classic Smart Card Personalization . . . . . . . . . . . . . 47
Return Values from the Sample Code SCard Wrapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Application Responsibilities with Single-Wire Smart Card . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Laser Engraving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Retrieve Laser Card Setup Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Retrieve Laser Elements in a Setup File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Use the Laser Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Import or Export Laser Setup Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Installed Printer Status, Supplies Status, and Counter Status. . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Printer Status Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Printer Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Printer Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Message Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Printer Connection Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Printer Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Sample Code—Printer Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Supplies Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Sample Code—Supplies Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Card Counts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Get Card Counts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Status XML File for Single Input Hopper Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Status XML for Six-Position Input Hopper Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Reset Card Counts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Sample Code—Card Counts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Hopper Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Get Hopper Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Input Hopper Status XML File for a CR805 Retransfer Card Printer . . . . . . . . . . . . . . . 65
Input Hopper Status XML File for a Non-Retransfer Printer . . . . . . . . . . . . . . . . . . . . . . 66
Locking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Lock or Unlock the Printer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Change the Lock/Unlock Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Password Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Determine the Success of a Lock Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Sample Code—Locking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Activate or Deactivate the Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Sample Code—Activate or Deactivate Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Change the Printer State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Sample Code—Change the Printer State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

13
 Restart the Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Sample Code—Restart Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Interactive Mode Best Practices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Appendix A: Error Description Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

Appendix B: Using the Java SDK Sample Code with Eclipse . . . . . . . . . . . . . . . . . . . . B-1

Appendix C: Suppressing the Driver Message Display . . . . . . . . . . . . . . . . . . . . . . . . . C-1

Enabling Driver Silent Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1
Silent Mode Operation Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-2

Appendix D: Print a UV Photo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-1

Appendix E: References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-1

14
Chapter 1: Introduction

The Application Programming Interface (API) built into the XPS Card Printer Windows driver
(referred to as “the driver” in the remainder of this Guide) provides two methods that your
application can use to control card personalization operations through the driver. Both use built-
in Windows operating system interfaces.
 Use the driver Print Ticket. Print Ticket is a required feature of any driver using the XML Paper
Specification (XPS) print driver architecture. A Print Ticket tells the printer how to process a
print job. Through Print Ticket, your application can override the driver’s printing preferences
on a job-by-job basis.
 Use the Windows IBidiSpl interface. The IBidiSpl interface is the Microsoft preferred API for
printer control. Using the IBidiSpl interface, your application places the driver in “interactive
mode,” where the application has fine-grained job control and can access data on the card
during the card personalization process.

Java does not directly support the IBidiSpl interface. Datacard has created a C++
helper DLL that your Java application uses as the interface for interactive printer
control. The helper DLL is included with the Software Development Kit (SDK).

The XPS Card Printer Windows Driver SDK (referred to as “the SDK”) includes documentation and
sample code that describe and demonstrate how to use both Print Ticket and the IBidiSpl
interface.

To learn more about Print Ticket and the IBidiSpl interface, refer to Appendix E:
"References”.

SDK Programmer’s Reference Guide 1

 The interfaces documented in the SDK provide the following capabilities to your application using
the driver.

Not all of the following capabilities of the SDK are available through a Java application.
Refer to Chapter 2: "SDK Sample Code” for more information.

 Print while modifying printing characteristics using the Print Ticket:

 Print one- or two-sided
 Disable printing on one or both card sides
 Specify the copy count
 Print in portrait or landscape orientation
 Rotate a card side by 180 degrees
 Select from the predefined topcoat and print blocking
 Specify the input hopper, including the exception hopper, to use when selecting a card
 Use escaped text in the card data to set topcoat blocking rectangles, and set print blocking
rectangles
 Use escaped text in the card data to encode standard format magnetic stripe data
 Use escaped text in the card data to specify the input hopper used to select the card
 Use escaped text in the card data to emboss, indent, and top a card when printing to a
CE-series printer
 Disable the application of topping foil on embossed cards
 Read magnetic stripe data
 Encode custom magnetic stripe data
 Stage a smart card so it can be personalized
 Stage and personalize a smart card using the single-wire smart card interface
 Read and write data to a MIFARE Classic chip smart card
 Laminate, debow, and impress a card
 Process more than one job at a time
 Read the bar code on a serialized overlay
 Place pre-serialized cards in a bar code reader so that the bar code can be read
 Send laser engrave data to a laser system
 Check whether the driver or printer is busy and wait before starting a job

2 Introduction
  Check the hopper status
 Monitor supplies and printer status
 Get printer and driver error messages
 Recover from printer and driver errors
 Get job status for the current interactive mode job
 Get a count of cards processed by the printer
 Reset the resettable card count values stored in the printer
 Activate or deactivate a printer
 Change the printer state to online, offline, or suspended
 Restart the printer

The SDK supports the same Microsoft Windows operating systems as the driver.

Installation
For most situations, there are no SDK components to install with your application. You need
version 7.2 or newer of the XPS Card Printer Driver and a Datacard SD, CD, or CE series card
printer, or a Entrust Datacard CR805 retransfer card printer. A C++ helper DLL is included for Java
applications because they cannot interface directly to the IBidiSpl COM interface.

SDK Programmer’s Reference Guide 3

4 Introduction
Chapter 2: SDK Sample Code

The SDK includes sample code that demonstrates the details you need to
successfully use the driver API in your application.

Sample Code
The SDK sample code demonstrates specific card personalization tasks using best practices for
Print Ticket usage, job sequencing, and basic error handling. All the samples are console
applications to make it easier to integrate the code into your application. Samples are provided in
C++, C#, VB.NET, and Java. The C++, C#, and VB.NET samples use direct calls to the IBidiSpl
interface. The Java samples use calls to the helper DLL (dxp01sdk_IBidiSpl_interop.dll).

If you use the SDK sample code to send a job to a shared printer, you must specify the
fully qualified printer name. Refer to the Driver Guide for complete information
about setting up shared printers.

Samples Included in the SDK

The SDK includes the following samples:

Sample Function Code Sample

Print print**

Magnetic Stripe magstripe

Bar Code BarcodePark*

Smart Card smartcard

Single-Wire Smart Card smartcard_singlewire

Single-Wire MIFARE Classic Smart Card smartcard_singlewire_mifare*

Lamination lamination*

Laminator Serialized Overlay lamination_barcode_read*

Emboss and Indent emboss_indent*

Laser Engraving laser*

SDK Programmer’s Reference Guide 5

 Sample Function Code Sample

Print Locking locks*

Printer Control printer_control*

Printer State printer_state*

Status status
* Not available in Java
** The Java Print sample includes emboss and indent functions.

Print Sample (Not Interactive)

Use the Print sample to demonstrate the print functionality of the printer and driver.

The Print sample uses the Print Ticket to override the driver preferences for:
 One- or two-sided printing
 Copy count

The copy count option is not used whenever the StartJob command is issued.

 Per card-side portrait or landscape orientation (Java is limited to card level orientation)
 Input hopper used to select the card *
 Predefined topcoat and print blocking patterns *
 Per card-side 180-degree rotation *
 Per card-side disabling of printing *

* Java does not support these features.

The Print sample also demonstrates:

 Color graphics printing
 K (black) text and K graphics printing
 Custom topcoat and print blocking using escapes
 Standard IAT-format magnetic stripe encoding using escapes
 Ability to select the input hopper to use (the default is hopper 1; specify “exception” to select
the exception hopper)
 Ability to check the input hopper status before sending the card job
 Ability to poll for job status and error conditions

6 SDK Sample Code

 The Java Print sample also demonstrates the following:
 Embossing on the front side of the card

Magnetic Stripe Sample

The Magnetic Stripe sample demonstrates ISO or JIS magnetic stripe encoding, with options to
read the magnetic stripe data, print text on the front of the card, and poll for job completion
status and error conditions. The print and magnetic stripe data is part of the sample and cannot
be changed.
Smart Card Sample

The Smart Card sample demonstrates parking a card in the printer smart card reader, moving the
card from the reader, and includes options to specify whether the smart card chip is on the back
of the card, print on the front of the card, and poll for job completion status and error conditions.
The print data is part of the sample and cannot be changed.
Bar Code Park Sample

The printer must be equipped with the optional bar code reader for this sample to
function.

The Barcode Park sample demonstrates parking a card with a pre-serialized bar code in the bar
code reader so that the bar code can be read and then moving the card out of the reader. The
sample also includes options to park the card so that a bar code on the back of the card can be
read (the default is to read a bar code on the front of the card), print text on the card, and to poll
for job completion status and error conditions. The print data is part of the sample and cannot be
changed. Your program then can specify whether to continue (the bar code read was successful)
or reject (the bar code read failed) the card. The sample prints text if the bar code read is flagged
as successful.

This sample is not available in Java.

Single-Wire Smart Card Sample

The printer must be equipped with the single-wire smart card option for this sample
to function correctly.

The Single-Wire Smart Card sample uses the integrated smart card reader that communicates
with the personalization application using the same cable the driver uses to communicate with
the printer. It demonstrates parking a card in the printer smart card reader, moving the card from
the reader, and includes options to specify whether the smart card chip is on the back of the card,
print on the front of the card, and to poll for job completion status and error conditions. The print
data is part of the sample and cannot be changed.

SDK Programmer’s Reference Guide 7

Single-Wire MIFARE Classic Smart Card Sample

The printer must be equipped with the single-wire smart card option. You must
use the proper smart cards for this sample to function correctly.

This sample demonstrates smart card operations including reading and writing to the chip for a
MIFARE Classic smart card. It uses the single-wire smart card tunnel and Duali reader commands
for a MIFARE Classic application. The sample moves the card into and out of the smart card
reader, and includes options to specify whether the smart card chip is on the back of the card,
print on the front of the card, and to poll for job completion status and error conditions. The print
data is part of the sample and cannot be changed.

This sample is not available in Java.

Lamination Sample

The printer must be equipped with a laminator for this sample to function.

The Lamination sample demonstrates using Print Ticket to set the lamination options for one or
both lamination stations. It overrides the driver printing preferences settings for those options.
The sample allows you to specify the laminator to use (L1 or L2), and the sides of the card to
laminate. It also includes the option to poll for job completion status and error conditions.

This sample is not available in Java.

Read and Verify Laminator Serialized Overlay Sample

The printer must be equipped with a laminator, a bar code scanner, and serialized
overlay loaded in the L1 laminator cartridge for this sample to function.

This sample demonstrates using the SDK API to retrieve the value of a serialized overlay bar code
from the laminator. It uses the lamination settings specified in the driver, prints a card, and polls
for job completion status and error conditions. It includes a verify option, which allows the
application to control whether the card should continue or be rejected, based on the value
returned. The sample also includes options to specify a wait time to read the bar code data and
to save the bar code read data to a file.

This sample is not available in Java.

8 SDK Sample Code

Emboss and Indent Sample

The Emboss and Indent sample demonstrates the use of escapes to emboss, indent, and apply
topping foil to a card using a Datacard CE-series system. The emboss and indent data is part of the
sample and cannot be changed. The sample also includes options to specify an input hopper,
disable topping foil application, and poll for job completion status and error conditions.

This sample is not available in Java. However, the Java print sample includes an
option that allows you to emboss the front side of the card.

Laser Sample

This sample works only with a CL900 Desktop Laser Personalization System.

The Laser sample demonstrates laser engraving on a card in the laser system. The sample
specifies the laser setup file to use, and engraves the data on the card. Additional options allow
you to transfer laser setup .zip files between the laser system and the computer, and query laser
card setups and their elements. The sample also includes options to encode ISO magnetic stripe
data, print text on the card (depending on the printer capabilities), and poll for job completion
status and error conditions. The laser engraving, print, and magnetic stripe data are part of the
sample and cannot be changed.

This sample is not available in Java.

Print Locking Sample

The Print Locking sample demonstrates locking and unlocking the printer using a password (for
printers that are equipped with a lock). The sample also allows you activate or deactivate a
printer using the password, to change the password, or set it to a blank password. The sample
locks the printer when the password is changed.

This sample is not available in Java.

Printer Control Sample

The Printer Control sample demonstrates a way to cancel all jobs in the printer, reset cards counts
that are resettable, and restart the printer. Using this sample to cancel jobs allows you to return
the printer to a known good state. In addition to canceling jobs active, or queued, in the printer,
any job in an error state in the driver also is canceled.

This sample is not available in Java.

SDK Programmer’s Reference Guide 9

Printer State Sample

The Printer State sample demonstrates changing the printer state to offline, online, or
suspended.

This sample is not available in Java.

Status Sample

The Status sample demonstrates using interactive mode to retrieve printer options, printer status
messages, card counts, job completion status, and error conditions.

Sample Code Location

The sample source code in located in the Samples folder. Select the folder that matches the
programming language you are interested in, and then select the folder for the sample containing
the features you want to learn about.

Compiled versions of the samples for Visual C++, Visual C#, and VB.NET are included in the exes
folder. These allow you to demonstrate the sample code without your having to build the code
yourself. Each sample includes help text that describes the parameters you can enter. To view the
help from a command line, open the appropriate language folder, and select the operating
system folder for your computer. Open a command prompt window and enter the full path name
of the sample.

The compiled samples have the following runtime dependencies.

 C++: Requires Microsoft Visual C++ 2013 Redistributable Package (x86 and x64), or newer.
Use the following link to download the appropriate software package:
https://www.microsoft.com/en-ca/download/details.aspx?id=40784
 C# and VB.NET: Require Microsoft .NET v4 Client Framework.

Developer Environments
The sample code was developed using the following tools. You are not required to use these, but
their use guarantees that the sample code builds without issue.
 C++, C#, and VB.NET: Microsoft Visual Studio 2013, or newer. (You can use any edition,
including the free Express Edition, for C# and VB.NET. Visual C++ requires the Professional
edition at a minimum.)
 Java: Eclipse Helios release. Appendix B: "Using the Java SDK Sample Code with Eclipse”
contains step-by-step instructions for importing and building the SDK Java sample code with
Eclipse. In addition the Java helper DLL requires that the Microsoft Visual C++ 2013, or newer,
Redistributable Package be installed. The download link is shown in the previous section.

10 SDK Sample Code

Printing
Your application can either print or block areas on the card from printing using conventional
printing APIs along with escapes. This method is always used, even when a job includes
interactive mode operations for other card personalization tasks or monitoring job status.

Using Print Ticket, a Microsoft Visual C++, C#, or VB.NET application can override any of the
printing preferences set in the driver's Printing Preferences window.

Java printing does not have access to the Print Ticket, so Java applications are limited to the
following:
 Card orientation (portrait or landscape) for the entire card, not per side
 One- or two-sided printing
 Copy count

The driver separates the print items into separate images expected by the printer (color,
monochrome, UV). The images that are created are based on both of the following:
 The type of print items in the card design
 The type of ribbon installed in the printer

The Card Printer Driver always uses the ribbon panels designated for the current card side and
adjusts the print items on the card to create the best possible image using those panels.

The following sections describe rules for rendering card design elements.

Text Printing
The driver uses the following rules to determine which panels are used to print text:
 If the printer has a color ribbon, any text that is 100% opaque and pure black is rendered by
the monochrome black (K) ribbon panel if one is available for the current card side.
Otherwise, black text is rendered using the color panels. Text that is 100% opaque and pure
white is “punched out” of both the color and monochrome panels. In other words, the white
text is created by not printing any color so the white card background shows through. All
other text is rendered using the color ribbon panels.
 If the printer has a monochrome ribbon, all non-white text is converted to pure black and
prints the same as pure black text would. Pure white text is punched out of any color
surrounding it.
 If the printer has a ribbon that includes an ultraviolet (UV) fluorescent (F) panel, text that is
100% opaque and is set at RGB(217,217,217) is rendered by the F panel.

SDK Programmer’s Reference Guide 11

Raster Graphics Printing
Raster graphics are images with formats such as bmp, jpeg, png, and tiff.

The driver uses the following rules to determine which panels to use when printing a raster
graphic:
 If the printer has a color ribbon with a K panel on the current card side, a raster graphic is
rendered by the monochrome (K) ribbon panel when any of the following are true:
 It is a 2-color (1 bpp) image with black being one of the colors
OR
 It is a 100% opaque image with only pure black and pure white pixels
OR
 An image contains any black pixels and the printing preference “Print black image pixels
using monochrome” is enabled. In this case, only the near-black pixels are printed with
the K panel.
All other images are rendered to the color panels.

Due to the way JPEG compresses images, it is unlikely that a JPEG image will ever
have only black and white pixels.

 If the printer has a monochrome ribbon, all raster graphics are rendered by the monochrome
(K) ribbon panel. Images that normally would be rendered to the color panels (for example,
photos) are half-toned to preserve the image details.
 If the printer has a ribbon with a UV (F) panel, a raster graphic is rendered by the F panel
when it is a 100% opaque image where one color is RGB(217,217,217) and the other color is
pure white.

12 SDK Sample Code

Vector Graphics Printing
Vector graphics are images with formats, such as WMF. These images are represented by a series
of commands that draw graphic objects to create the complete image. Most vector graphics
elements have an outside border (the stroke) and an inside color (the fill).

The driver uses the following rules to determine which panels are used to print a vector graphic
element.

 If the printer has a color ribbon with a K panel on the current card side, a vector graphic is
rendered by the monochrome (K) ribbon panel when:
 There is no fill and the stroke is 100% opaque and pure black
OR
 There is no stroke and the fill is 100% opaque and pure black
OR
 Both the fill and stroke are 100% opaque and pure black
All other elements are rendered to the color panels.
 If the printer has a monochrome ribbon, all vector graphic elements are rendered by the
monochrome (K) ribbon panel. Elements that would normally be rendered to the color panels
are half-toned to make them appear as a shade of gray.
 If the printer ribbon includes a UV (F) panel, a vector graphic element is rendered by the
F panel when it is 100% opaque and is set to RGB(217,217,217).

Topcoat and Print Blocking

A card design may have features that must not be printed on or have topcoat applied over them.
Examples include a smart card chip, a magnetic stripe, and a signature panel. Using escapes, you
can specify rectangles to block printing, block topcoat, or apply topcoat. Details about using
escapes for blocking printing and topcoat can be found in the “Print Blocking Escapes” section of
the Driver Guide.

The CR805 retransfer card printer blocks printing on the back side of the card only if the ribbon
includes an inhibitor panel on the back side panel set. When you use escapes to specify a non-
printing area over a smart card chip on the front of the card, the primer panel is not applied,
preventing the retransfer film (and any printing) from adhering to the card. Refer to the “Print
Blocking in a Retransfer Printer” section of the Driver Guide for complete information.

For more information on non-printing areas, refer to the “Non-Printing Areas” section of your
printer’s Installation and Administrator’s Guide.

SDK Programmer’s Reference Guide 13

Controlling Card Printing Preferences
The Windows printing interface allows job-level application control of:
 Card orientation (portrait or landscape)
 Two-sided printing
 Copy count

Applications written in Microsoft Visual C++, C#, and VB.NET can use the Print Ticket to access
custom preferences created just for the XPS Card Printer Driver. The custom preferences are:
 Per side card orientation
 Per side 180-degree card image rotation
 Per side disable printing flag that ignores the print data in the job
 Selection of one of the print and topcoat blocking preset masks
 Input hopper used to select the card
 Split-ribbon color printing (non-retransfer printers only)
 Lamination, debow, and impress actions
 A second layer of retransfer material applied to the card (CR805 retransfer card printer only)

Sample Code that Demonstrates Printing

The SDK includes sample code with language-specific implementation details for printing. The
samples are:

Visual C++, Visual C#, print

and VB.NET

Java javaprint.java

Compiled samples exes

14 SDK Sample Code

Get the Status of a Print Job
Your application can retrieve the status for the current print job to determine whether the printer
is still actively processing the card.

PrinterJobID is used to identify the job. The printer job ID is retrieved by calling
Printer.PrintMessages:Read after the print job has been submitted to the printer. Once the
printer job ID is known, the job status can be retrieved using Printer.JobStatus:Read with the
PrinterJobID of the current job. Refer to “Get the Status of an Interactive Job” on page 27.

Embossing
Your application can emboss, indent, and apply topping foil to a card with the Datacard CE840
instant issuance system by using escapes. The emboss_indent sample also allows you to disable
the application of topping foil.

Escapes that control embossing and indenting are designed to work across a wide range of
applications. The escapes rely on special text character sequences to alert the driver that the text
that follows is meant as a command and is not to be printed.

For more information about embosser escapes, including examples and limitations, refer to your
printer’s Driver Guide.

Sample Code that Demonstrates Embossing

For working code showing embossing, indenting, and topping, refer to the following samples:

Visual C++, Visual C#, emboss_indent

and VB.NET

Java Java does not include a separate embossing sample.

However, the javaprint.java print sample includes an
option that allows you to emboss the front side of the
card. Refer to “Sample Code that Demonstrates Printing”
on page 14.

SDK Programmer’s Reference Guide 15

Laminating
Your application can laminate and impress a card when using a printer with a laminator. If you
plan to use the same lamination settings for all cards, you simply can set the driver’s printing
preferences. However, your application can override the driver preferences for laminating, either
by modifying the job’s Print Ticket or by including escapes in the text data for the job.

Using the Print Ticket to control lamination is the preferred method because it allows your
application to control laminating more securely than by using escapes. The SDK sample code
demonstrates how to control these operations using the Print Ticket.

Escapes that control lamination and impressing are designed to work across the widest range of
applications. The escapes rely on special text character sequences to alert the driver that the text
that follows is meant as a command and is not to be printed. For more information about
lamination escapes, including examples and limitations, refer to your printer’s Driver Guide.

Laminator Bar Code Read

If your CLM laminator is equipped with a bar code scanner and you have the proper supplies
installed, you can retrieve the unique value printed on each serialized overlay patch by reading
the matching bar code printed on the lamination material next to the patch. This value provides
your application with a traceable identifier that links the patch applied to the card to the other
data used to personalize the card. Reading the bar code is an interactive mode operation. Refer
to “Read Data from a Serialized Laminate Bar Code” on page 37.

Sample Code that Demonstrates Laminating

For working code showing Print Ticket control of laminating, printing, and polling for job status
and error conditions, and bar code read, refer to the following samples:

Visual C++, Visual C#, lamination

and VB.NET lamination_barcode_read

Java Java does not include a lamination sample at this time.

16 SDK Sample Code

Laser Engraving
Your application can send data to the CL900 laser system that can be laser engraved on a card,
query laser elements from a setup file, and import or export card setup files to the laser system.
The laser system requires additional laser setup files and card design information that is present
on the laser system.

The laser sample uses a byte interface to communicate with the printer driver. Laser engraved
images must be base64 binary-encoded. The driver expects the laser data to be in bytes so that it
is consistent with the laser interface.

In addition to laser engraving, the laser sample also allows you to:
 Transfer laser setup files between the PC and the laser system. You can specify to import
(transfer files from the PC to the laser system) or export (transfer files from the laser system
to the PC) the files.
 Retrieve the names of all laser card setup files present in the laser system.
 Retrieve variable laser elements in each laser card setup file.

Refer to the documentation for the laser system for complete information about defining laser
setup and card design files.

Sample Code that Demonstrates Laser Engraving

For working code showing Print Ticket control of laser engraving, magnetic stripe encoding,
printing, and polling for job status and error conditions, refer to the following sample:

Visual C++, Visual C#, laser

and VB.NET

Java Java does not include a laser sample at this time.

SDK Programmer’s Reference Guide 17

18 SDK Sample Code
Chapter 3: Interactive Mode
Using the IBidiSpl Interface

Interactive mode is used when your application needs to control the

movement of the card in the printer, retrieve data from the card, or
retrieve error and job status information.

Overview
The XPS Card Printer Windows driver uses the Microsoft IBidiSpl interface for bidirectional
communication between your application and the printer in interactive mode. The following
interactive mode functions are supported by this release of the driver SDK:
 Job control of interactive card personalization functions
 Job control for error detection and recovery
 Encode magnetic stripe
 Read magnetic stripe
 Smart card park (front or back of card)
 Get supplies and printer status
 Single-wire smart card park and personalization
 Read serialized patch overlay bar code
 Place pre-serialized cards in a bar code reader so that the bar code can be read
 Send laser engrave data to a laser system
 Monitor and reset card counts
 Get installed printer options
 Get the input hopper status (CR805 retransfer card printer only)
 Specify the input hopper, including the exception hopper, to use when selecting a card
 Lock and unlock a printer with locks, and change a password
 Activate or deactivate the printer
 Change the printer state
 Restart the printer

SDK Programmer’s Reference Guide 19

 Printing, magnetic stripe encoding using escapes or fonts, topcoating, embossing, laminating,
and impressing are done outside interactive mode, but can be mixed with interactive functions
within the same job.

Java does not have direct access to the IBidiSpl interface. A C++ helper DLL is provided
with the SDK that Java applications can use for interactive mode.

IBidiSpl Requests
The following IBidiSpl requests are used to implement the functions described in the “Overview”
on page 19:

Job control (normal)

 Printer.Print:StartJob:Set
 Printer.Print.EndJob:Set
 Printer.Action:Set
 Printer.JobStatus:Read

Job control (error state)

 Printer.PrintMessages:Read
 Printer.Action:Set

Card personalization
 Printer.MagstripeUnit:Back:Encode
 Printer.MagstripeUnit:Back:Read
 Printer.MagstripeUnit:Front:Encode
 Printer.MagstripeUnit:Front:Read
 Printer.BarcodeUnit:Front:Park
 Printer.BarcodeUnit:Back:Park
 Printer.SmartCardUnit:Front:Park
 Printer.SmartCardUnit:Back:Park
 Printer.SmartCardUnit:SingleWire:Connect
 Printer.SmartCardUnit:SingleWire:Disconnect
 Printer.SmartCardUnit:SingleWire:Transmit
 Printer.SmartCardUnit:SingleWire:Status

20 Interactive Mode Using the IBidiSpl Interface

  Printer.SmartCardUnit:SingleWire:Control
 Printer.SmartCardUnit:SingleWire:GetAttrib

Laser engraving
 Printer.Laser:Engrave:SetupFileName:Set
 Printer.Laser:Engrave:Text:Set
 Printer.Laser:Engrave:Binary:Set
 Printer.Laser:SetupFileName:Get
 Printer.Laser:ElementList:Get
 Printer.Laser:Upload:File:Get
 Printer.Laser:Download:File:Set

Printer and supplies capabilities and status

 Printer.PrinterOptions2:Read
 Printer.CounterStatus2:Read
 Printer.SuppliesStatus3:Read
 Printer.ResetCardCount:Set
 Printer.Hopper:Status:Get

Laminator
 Printer.Laminator:BarcodeRead:Set
 Printer.Laminator:BarcodeRead:Get
 Printer.Laminator:BarcodeReadAndVerify:Set

Activation
 Printer.ActivatePrinter:Set

Printer control
 Printer.ChangePrinterState:Set
 Printer.Restart:Set

Lock control
 Printer.Locks:ChangeLockState:Set
 Printer.Locks:ChangePassword:Set

SDK Programmer’s Reference Guide 21

 Deprecated

The following IBidiSpl requests have been deprecated:

 Printer.PrinterOptions:Read was replaced by the following in an earlier version of the driver:
 Printer.PrinterOptions2:Read
 Printer.CounterStatus2:Read
 Printer.SuppliesStatus:Read
 Printer.SuppliesStatus:Read and Printer.SuppliesStatus2:Read were replaced by the following
in an earlier version of the driver:
 Printer.SuppliesStatus3:Read
 The CheckPrintRibbonSupplies and CheckEmbossSupplies options in StartJob. Use the
following IBidiSpl request to check the status of remaining supplies using the SDK:
 Printer.SuppliesStatus3:Read

Java Helper DLL Interface

The following Java helper DLL functions are used to implement the functions described in the
“Overview” on page 19:

Job control (normal)

 StartJob
 EndJob
 ResumeJob
 GetJobStatusXML

Job control (error state)

 CancelJob

Card personalization
 MagstripeEncode2
 MagstripeRead2
 SmartCardPark
 SCardConnect
 SCardDisconnect
 SCardGetAttrib

22 Interactive Mode Using the IBidiSpl Interface

  SCardStatus
 SCardTransmit

Printer and supplies capabilities and status

 GetPrinterOptions2
 GetPrinterCounterStatus2
 GetPrinterSuppliesStatus

Order and Timing of Interactive Job Operations

The application must implement the following interactive operations in a specific order or at a
specific time:
 A Start Job request is always the first operation
 An End Job or Cancel Job request is always the last operation
 An End Job request must not be issued until printing operations for the job have entered the
driver spooler.

Refer to the sample code for best-practices examples.

Determine the Success of an IBidiSpl Request

Because all IBidiSpl requests return success, the return value cannot be used to determine the
outcome of the request. IBidiSpl requests also return a printer status XML structure. This
structure contains information about whether the request succeeded or failed and, if it failed,
information about the error that was detected.

For operations that return data from the printer, this structure also contains the data
if the operation succeeded.

The following example shows the printer status XML structure returned from a failed StartJob
command. The command failed because the printer failed to pick a card.
<?xml version="1.0" ?>
<!-- Printer status xml file.-->
<PrinterStatus>
<ClientID>STATUSTEST</ClientID>
<WindowsJobID>0</WindowsJobID>
<PrinterJobID>780</PrinterJobID>
<ErrorCode>111</ErrorCode>
<ErrorSeverity>4</ErrorSeverity>
<ErrorString>Message 111: Card not picked.</ErrorString>
<DataFromPrinter><![CDATA[ ]]></DataFromPrinter>
</PrinterStatus>

SDK Programmer’s Reference Guide 23

 The printer status structure contains the following elements:

Element Description of the element value

ClientID A unique identifier of the client that created the job. This
element is not used at this time.

WindowsJobID The Windows Job ID assigned by the operating system.

PrinterJobID The Print job ID assigned by the driver.

ErrorCode If the command succeeded, the ErrorCode is 0 (zero). A non-

zero value means an error was detected. For non-zero
ErrorCode values, the ErrorSeverity and ErrorString elements
also contain values.

ErrorSeverity Errors are classified into severity levels (1, 2, 3, 4, or 5). The
severity level determines which recovery actions are possible.

ErrorString A short human-readable description of the error, including

the error number. This matches the message that displays on
the printer LCD panel.

DataFromPrinter If the command was intended to read data from the card in
the printer and the read operation was a success, this
element contains the data in the CDATA section.

Start and End an Interactive Job

To start a job that contains one or more interactive operations, your Visual C++, Visual C#,
or VB.NET application must call the IBidiSpl interface with the schema set to
Printer.Print:StartJob:Set. You can specify the input hopper, including the exception
hopper, from which to pick the card. If no hopper is specified, the driver picks a card from
hopper 1.

The StartJob request might fail and return error 506. This indicates that the driver or printer is
busy and cannot accept another job at this time. A laminating system can have multiple active
jobs, and your application might need to wait and retry the StartJob request when the printer is
ready to accept it. Refer to the source code samples to see how the StartJob request handles
error 506.

The input hopper selection and StartJob options are not supported by Java at this
time.

For Java, call the StartJob method of the dxp01sdk_IBidiSpl_interop.dll.

The start job request always must be the first IBidiSpl request.

24 Interactive Mode Using the IBidiSpl Interface

 To end a job, the Visual C++, Visual C#, or VB.NET application calls the IBidiSpl interface
with the schema set to Printer.Print:EndJob:Set. For Java, call the EndJob method of the
dxp01sdk_IBidiSpl_interop.dll. The end job command is issued after the last interactive operation
is successful.

If printing follows the interactive operations, the end job request cannot be sent until
the print data appears in the spooler. Submitting an end job immediately results in
the job ending before the print data is detected. This results in a second card that
contains only the print data. The SDK sample code demonstrates a reliable method
for detecting that the print data is in the spooler.

SDK Programmer’s Reference Guide 25

Sample Code
For working code showing interactive mode Start Job, End Job, and basic error recovery, refer to
the following samples:
Visual C++, Visual C#, magstripe
and VB.NET smartcard

Java Magstripe.java
SmartCard.java

26 Interactive Mode Using the IBidiSpl Interface

Get the Status of an Interactive Job
Your application can retrieve the status for the current interactive job to determine if the printer
is still actively processing the card or if the card is complete. The PrinterJobID is used to identify
the job. This ID is part of the Printer Status structure returned from the Start Job request.

To retrieve job status, your application uses the IBidiSpl interface with the schema set to
Printer.JobStatus:Read to send an XML structure with the Printer Job ID of the current
interactive job. For Java, call the GetJobStatusXML method of the Java helper DLL
(dxp01sdk_IBidiSpl_interop.dll).
<?xml version=\"1.0\"?>
<!--job status xml-->
<JobStatus>
<PrinterJobID>5860</PrinterJobID>
</JobStatus>

The Job Status request returns the job status in another XML structure.
<?xml version="1.0" ?>
<!-- Job status xml file. -->
<JobStatus>
<ClientID>STATUSTEST</ClientID>
<WindowsJobID>5</WindowsJobID>
<PrinterJobID>5680</PrinterJobID>
<JobState>JobActive</JobState>
<JobRestartCount>0</JobRestartCount>
</JobStatus>

The ClientID, WindowsJobID, and PrinterJobID have the same meaning as the Printer Status
elements returned from other IBidiSpl requests. The JobState and JobRestartCount are unique to
this request.

Element Description of the element value

JobState The state of the job. The value is one of the following:
JobActive, JobSucceeded, JobFailed, JobCancelled, or
NotAvailable.

JobRestartCount The number of times the job was retried. This is always
zero for interactive jobs.

SDK Programmer’s Reference Guide 27

 Using the JobState value, your application can determine if the card is still being processed by the
printer or, if it has completed, whether it was personalized successfully.

JobState value What it means

JobActive A card is still being personalized by the printer.

JobSucceeded The card is complete. The job completed without a detected

error.

JobFailed The card is complete. An error forced the job to terminate

before the card personalization process completed.

JobCancelled The card is complete. The job was canceled before the card
personalization process completed.

NotAvailable There is no information for the PrinterJobID provided. Either

the value provided is wrong or this is no longer the current
job.

Sample Code
For working code showing interactive mode Job Status use, refer to the following samples:
Visual C++, Visual C#, magstripe
and VB.NET smartcard
status

Java SmartCard.java
JobStatusXML.java

28 Interactive Mode Using the IBidiSpl Interface

Interactive Mode Error Recovery
When the driver is in interactive mode, errors are reported back to your application through
the printer status structure returned by every IBidiSpl request. Your application also can get
this information by calling the IBidiSpl interface with the schema set to
Printer.PrintMessages:Read.

Error-Related Values in the Printer Status Structure

Three values in the Printer Status structure are used to communicate error information to your
application.

Element Description of the element value

ErrorCode If the command succeeded, the ErrorCode is 0 (zero). A non-zero value

means an error was detected. The value of the ErrorCode element will be
one of the message numbers listed in Appendix A: "Error Description
Strings”. For non-zero ErrorCode values, the ErrorSeverity and ErrorString
elements also contain values.

ErrorSeverity Errors are classified into severity levels (1, 2, 3, 4, or 5). The severity level
determines which error recovery actions are possible.

ErrorString Contains a short description of the error, including the error number.
Appendix A: "Error Description Strings” lists the ErrorString values your
application can receive from the driver while in interactive mode. The
ErrorString value will be in the language of the operating system if the
language is one of the translations released with the driver.

ErrorSeverity Severity description Action

1 Alert—Unrecoverable issue for job Cancel job

2 Critical—Unrecoverable issue for job Cancel job

3 Error—Unrecoverable issue for card; Restart or cancel job

recoverable issue for job

4 Warning—Recoverable issue for card Resume or cancel job

5 Notice—Information only None required

SDK Programmer’s Reference Guide 29

Recovery from Errors
To clear an error while in interactive mode, your application uses the IBidiSpl interface with the
schema set to Printer.Action:Set to send an XML structure with the Printer Job ID of the
current interactive job, the ErrorCode you are responding to, and the action you want to take.
Java can call the CancelJob, ResumeJob, or SendResponseToPrinter method of the Java helper
DLL (dxp01sdk_IBidiSpl_interop.dll).

You must set the ErrorCode to match the error you are responding to for successful
error recovery.

The following example shows the structure sent to cancel a job when the input hopper is empty.
<?xml version="1.0"?>
<!--printer command xml-->
<PrinterAction>
<Action>100</Action>
<PrinterJobID>5860</PrinterJobID>
<ErrorCode>112</ErrorCode>
</PrinterAction>

Action Allowed for

value Action description ErrorSeverity level

100 Cancel—Reject the current card. End the current job. All

101 Resume—Attempt to continue with the current card. 4

Basic Error Recovery (Recommended)

The most robust form of error recovery from an interactive mode error is to cancel the job. Using
this error recovery strategy, your application reports the job as failed and, if a card has been
picked, it is ejected from the printer. After you correct the cause of the error, you can attempt the
card personalization job again.
Advanced Error Recovery

By evaluating the ErrorSeverity value, your application sometimes can offer to resume the job
after the cause of the error is corrected. In practice, this complicates error recovery because the
application must poll the driver for printer status in the event that the error is corrected and
cleared using the printer LCD display. If the ErrorCode goes to 0, the application can assume that
the error was cleared using the printer LCD. Polling the driver for printer messages is not available
to Java applications.

30 Interactive Mode Using the IBidiSpl Interface

Cancel All Jobs

If you know that your application is the only one sending jobs to the printer, you can cancel all the
jobs in the printer to return it to a known good state. This is not recommended for production
use, but can be helpful during development.

A laminating system can have multiple active jobs. Using Cancel All Jobs cancels even
those jobs that are not in an error state.

Sample Code

For working code showing how to cancel all jobs, refer to the following samples:
Visual C++, Visual C#, printer_control
and VB.NET

Java Java does not have a sample showing cancel all jobs.

Errors Cleared at the Printer

After an error condition is corrected at the printer, the operator can sometimes use either the
application or the printer’s front panel to report that the error is corrected. We recommend that
operators be instructed to use the application to acknowledge that error conditions are
corrected. Otherwise, the application may get out of sync with the state of the printer.
Suppress the Driver Message Display

If you prefer to have your application manage error reporting and resolution, you can configure
the driver to suppress the display of messages. Refer to Appendix C: "Suppressing the Driver
Message Display” for details.

SDK Programmer’s Reference Guide 31

Encode a Magnetic Stripe with Data
There are three ways to encode data onto a magnetic stripe on the a card.
 Use magnetic stripe escapes in the card data to instruct the driver to encode an IAT track; the
data is included between the escape characters. This is processed by the driver along with
the print data and does not require interactive mode. Refer to the “Magnetic Stripe Escapes”
section of the printer’s Driver Guide for details about how to use escapes for magnetic stripe
encoding.

 Use the magnetic stripe fonts installed with the XPS Card Printer Driver to encode IAT or JIS
formatted data by placing the data on the card design and specifying the magnetic stripe font
for the format and track desired. This is processed by the driver along with the print data and
does not require interactive mode. Refer to the “Magnetic Stripe Fonts” section of the
printer’s Driver Guide for details about how to use magnetic stripe fonts for magnetic stripe
encoding.
 Use the IBidiSpl interface to pass magnetic stripe data through the driver in the format
expected by the printer. This method is described in the following sections.

The printer must be configured to match the format of the magnetic stripe data
being sent.

Interactive Mode Magnetic Stripe Encoding

Using the IBidiSpl interface, a card’s magnetic stripe can be encoded on the front side or back side
of the card. The following assumes you are encoding to the back side of the card.

To encode a magnetic stripe with data, your application calls the IBidiSpl interface with the
schema set to Printer.MagstripeUnit:Back:Encode. For Java, call the MagstripeEncode2
method of the Java helper DLL (dxp01sdk_IBidiSpl_interop.dll).

The IBidiSpl commands used to encode only the magnetic stripe on a card are:

1. StartJob—The printer starts the job and picks the card.

2. MagstripeEncode—The application sends the magnetic stripe track data.
3. EndJob—The printer ejects the card into the output hopper.

32 Interactive Mode Using the IBidiSpl Interface

 The following flowchart illustrates magnetic stripe encoding:

SDK Programmer’s Reference Guide 33

Magnetic Stripe Track Data Format
When using interactive mode magnetic stripe encoding, the magnetic stripe track data must be
provided in the XML format the printer expects. The track data itself must be encoded as UTF-8
and then converted to base64 ASCII. Your application also is responsible for sending track data
that is valid for the magnetic stripe format configured at the printer.

The following example shows an XML structure with three tracks of IAT data: track 1 = TRACK1,
track 2 = 1122, track 3 = 321.
<?xml version="1.0" encoding="UTF-8"?>
<magstripe >
<track number="1">
<base64Data>VFJBQ0sx</base64Data>
</track>
<track number="2">
<base64Data>MTEyMg==</base64Data>
</track>
<track number="3">
<base64Data>MzIx</base64Data>
</track>
</magstripe >

Sample Code—Magnetic Stripe Encode

For working code showing interactive mode magnetic stripe encoding, refer to the following
samples:
Visual C++, Visual C#, magstripe
and VB.NET

Java Magstripe.java

34 Interactive Mode Using the IBidiSpl Interface

Read Data From a Magnetic Stripe
Using the IBidiSpl interface, data can be read from the tracks of a card’s magnetic stripe on the
back side of the card. To read data from the magnetic stripe, your application calls the IBidiSpl
interface with the schema set to Printer.MagstripeUnit:Back:Read. For Java, call the
MagstripeRead2 method of the Java helper DLL (dxp01sdk_IBidiSpl_interop.dll).

Like all IBidiSpl requests, the printer status XML structure is returned to your application. The
magnetic stripe track data is returned inside the CDATA element of the printer status structure.
This data comes directly from the printer without any modification from the driver.
<?xml version="1.0"?>
<!--Printer status xml file.-->
<PrinterStatus>
<ClientID>STATUSTEST_{200AEAAC-CA0A-4AF6-BD77-083A5836AE1A}</ClientID>
<WindowsJobID>0</WindowsJobID>
<PrinterJobID>5837</PrinterJobID>
<ErrorCode>0</ErrorCode>
<ErrorSeverity>0</ErrorSeverity>
<ErrorString></ErrorString>
<DataFromPrinter><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
<magstripe xmlns:SOAP-ENV="http://www.w3.org/2003/05/soap-envelope" xmlns:SOAP-
ENC="http://www.w3.org/2003/05/soap-encoding" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:DPCLMagStripe="urn:dpcl:magstripe:2010-01-19" xsi:type="DPCLMagStripe:MagStripe"
SOAP-ENV:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
<track number="1">
<base64Data>zw9PkBBQQzw9PkBBQUVJTVFVWV1hZWltcXV5fICEiIyQlJicoKSorLA==</
base64Data>
</track>
<track number="2">
<base64Data>MDEyMzQ1Njc4OTo7PD0+jc4OTo7PD0+MDEyMzQ1Ng==</base64Data>
</track>
<track number="3">
<base64Data>MDEyMzQ1Njc4OTo7PDDEyMzQ1Njc4OTo7PD0+MDEyMzQ1Njc4OTo7PD0=</
base64Data>
</track>
</magstripe>]]></DataFromPrinter>
</PrinterStatus>

The track data must be converted from base64 ASCII to the format required by your application.

For example, a job consisting of magnetic stripe read, magnetic stripe encode, and printing would
use the following operations in the order specified:
1. Start Job—The printer starts the job and picks the card.

2. Magnetic Stripe Read—The application reads the magnetic stripe track data.
3. Magnetic Stripe Encode—The application sends the magnetic stripe track data.
4. Print card side(s)—Use the Windows printing interface (for example, GDI, WinForms), not
IBidiSpl.

SDK Programmer’s Reference Guide 35

 5. Wait for the print data to enter the spooler.
6. End Job—The printer completes printing and then ejects the card into the output tray.

Sample Code—Magnetic Stripe Read

For working code showing interactive mode magnetic stripe read, refer to the following samples:
Visual C++, Visual C#, magstripe
and VB.NET

Java Magstripe.Java

Place a Card in the Bar Code Reader

If the printer is equipped with the optional bar code reader, the IBidiSpl interface allows you to
park a pre-serialized card in the reader, wait for the bar code on the card to be read, and then
move the card out of the reader. To park the card in the bar code reader, your application calls the
IBidiSpl interface with the schema set to either Printer.BarcodeUnit:Front:Park or
Printer.BarcodeUnit:Back.Park.

After the bar code read completes, your application controls if the card is placed in the reject tray,
or if it continues on to other personalization operations. To resume or cancel the job, use the
IBidiSpl interface with the schema set to Printer.Action:Set to send an XML structure with
the Printer Job ID of the current interactive job and the action you want to take.
<?xml version="1.0"?>
<!--printer command xml-->
<PrinterAction>
<Action>101</Action>
<PrinterJobID>6524</PrinterJobID>
<ErrorCode>0</ErrorCode>
</PrinterAction>

A Resume action (Action value = 101) indicates that the bar code read completed successfully,
and the card is ready for further processing.

A Cancel action (Action value = 100) indicates that the bar code read failed, and the card should
be rejected without any further personalization.

For example, a job consisting of bar code read and printing would use the following operations in
the order specified:
1. StartJob—The printer starts the job and picks the card.
2. ParkCard—The printer parks the card at the bar code station.

3. ResumeJob—The printer moves the card from the bar code station so that the card can be
processed further.

36 Interactive Mode Using the IBidiSpl Interface

 4. Print Card Side(s)—Use the Windows printing interface (for example, GDI, WinForms), not
IBidiSpl.
5. Wait for the print data to enter the spooler.
6. EndJob—The printer completes printing and then ejects the card into the output tray.

Use the SDK command BARCODE_PARK when the bar code is on the front side of the card or
BARCODE_PARK_BACK when a bar code is on the back side of the card.

For printers running D3 firmware, set the Printer Manager BarcodeLocation setting to CardFront
and use the SDK BARCODE_PARK and BARCODE_PARK_BACK commands to specify the card side
to read.

Read Data from a Serialized Laminate Bar Code

If the CLM laminator is equipped with the optional bar code scanner, the IBidiSpl interface allows
you to read data from the bar code printed on the serialized overlay material. To read the bar code
data, your application calls the IBidiSpl interface with the schema set to
Printer.Laminator:BarcodeRead:Get.

The application also can let the printer know whether or not the bar code data will be verified by
calling the IBidiSpl interface with the schema set to one of the following:
Printer.Laminator:BarcodeRead:Set or
Printer.Laminator:BarcodeReadAndVerify:Set.

The Printer.Laminator:BarcodeRead:Set command simply retrieves the bar code data and
the card continues automatically. When you use the Printer.Laminator:BarcodeRead
AndVerify:Set command, the printer stops after the bar code data is returned and waits for the
application to instruct it to continue or to reject the card.

The bar code read commands differ somewhat from other commands in that the act of reading
the bar code in the laminator occurs after the card is printed. Thus, your application makes the
request to read the bar code and then must wait and check for the data to be returned. The driver
SDK interface allows you to specify a value for the wait time, or to allow an infinite wait time (this
is the default). We recommend that your application does not specify a timeout value. This gives
the laminator time to warm up, which can take up to several minutes if it is just starting, before it
accepts the card for processing.

You also have the option to save the bar code read results to a file.

Sample Code—Serialized Laminate Bar Code Read

For working code illustrating best practices for the serialized laminate bar code read, refer to the
following samples:
Visual C++, Visual C#, lamination_barcode_read
and VB.NET

Java Java does not support this feature at this time.

SDK Programmer’s Reference Guide 37

Place a Card in the Smart Card Station
Using the IBidiSpl interface, a card can be placed (parked) in the printer’s smart card station
where it can be read, personalized, or both. To park a card in the printer’s smart card
station, your application calls the IBidiSpl interface with the schema set to
Printer.SmartCardUnit:Front:Park or Printer.SmartCardUnit:Back:Park. For Java,
call the SmartCardPark method of the Java helper DLL (dxp01sdk_IBidiSpl_interop.dll).

After smart card personalization completes, your application controls if the card is placed in the
reject tray, or if it continues on to other personalization operations. To resume or cancel the job,
use the IBidiSpl interface with the schema set to Printer.Action:Set to send an XML structure
with the Printer Job ID of the current interactive job and the action you want to take.
<?xml version="1.0"?>
<!--printer command xml-->
<PrinterAction>
<Action>101</Action>
<PrinterJobID>5860</PrinterJobID>
<ErrorCode>0</ErrorCode>
</PrinterAction>

A Resume action (Action value = 101) indicates that smart card personalization completed
successfully, and the card is ready for further processing.

A Cancel action (Action value = 100) indicates that smart card personalization failed, and the card
should be rejected without any further personalization.

For Java, call either the ResumeJob, CancelJob, or EndJob method of the Java helper DLL
(dxp01sdk_IBidiSpl_interop.dll).

For example, a job consisting of smart card encoding and printing would use the following
operations in the order specified:
1. StartJob—The printer starts the job and picks the card.
2. ParkCard—The printer parks the card at the smart card station.
3. ResumeJob—The printer moves the card from the smart card station so that the card can be
processed further.
4. Print Card Side(s)—Use the Windows printing interface (GDI, WinForms, etc.), not IBidiSpl.

5. Wait for the print data to enter the spooler.

6. EndJob—The printer completes printing and then ejects the card into the output tray.

38 Interactive Mode Using the IBidiSpl Interface

Sample Code—Smart Card Park
For working code showing interactive mode smart card station park, refer to the following
samples:
Visual C++, Visual C#, smartcard
and VB.NET

Java SmartCard.java

Personalize a Smart Card

If your printer is equipped with a single-wire smart card reader, you can personalize the card
using the driver SDK after the smart card is parked. The IBidiSpl requests used to do this are:
 Printer.SmartCardUnit:SingleWire:Connect
 Printer.SmartCardUnit:SingleWire:Disconnect
 Printer.SmartCardUnit:SingleWire:Transmit
 Printer.SmartCardUnit:SingleWire:Status
 Printer.SmartCardUnit:SingleWire:GetAttrib

Printer.SmartCardUnit:SingleWire:Connect
A Connect request establishes a connection between the calling application and a smart card
parked in the reader. If no card exists in the reader, an error is returned.

To connect to the smart card in the reader, use the IBidiSpl interface with the schema set to
Printer.SmartCardUnit:SingleWire:Connect. For Java, call the SCardConnect method of the
Java helper DLL (dxp01sdk_IBidiSpl_interop.dll).

SDK Programmer’s Reference Guide 39

Smart Card Connect Request—Required Information

Your application must create an XML structure indicating the protocol to use (contact or
contactless). The driver receives this XML formatted data as a BIDI_BLOB.
<?xml version=\"1.0\"?>
<!--smartcard connect xml-->
<SmartcardConnect>
<ProtocolName>SCARD_PROTOCOL_CL</ProtocolName>
</SmartcardConnect>

Protocol Name Value Connection Type

SCARD_PROTOCOL_CL Contactless

SCARD_PROTOCOL_T0_OR_T1 Contacted

Smart Card Connect Request—Return Values

 The IBidiSpl interface returns a printer status XML structure. The printer status includes a
valid ClientID, WindowsJobID (if applicable, 0 for interactive mode jobs), PrinterJobID, and
ErrorCode.
 If the ErrorCode is zero, the connection request was successful.
 If the ErrorCode is non-zero, the connection request failed. In this case, the printer status
XML file also contains values for ErrorSeverity and ErrorString.
 The CDATA section in the printer status XML structure returns any response from the smart
card reader.

40 Interactive Mode Using the IBidiSpl Interface

Smart Card Connect Request—Status Returned

The following example shows a printer status XML structure returned by a single-wire smart card
Connect IBidiSpl request. The smart card reader response is included in the CDATA section.
<?xml version="1.0"?>
<!--Printer status xml file.-->
<PrinterStatus>
<ClientID>Test-Win7_{716DD9A0-CF52-4176-B1C0-A10FA8DB055A}</ClientID>
<WindowsJobID>0</WindowsJobID>
<PrinterJobID>6049</PrinterJobID>
<ErrorCode>0</ErrorCode>
<ErrorSeverity>0</ErrorSeverity>
<ErrorString></ErrorString>
<DataFromPrinter><![CDATA[
<?xml version="1.0"?><!--smartcard response xml-->
<SmartcardResponse>
<Protocol>SCARD_PROTOCOL_RAW</Protocol>
<State> </State>
<Status>SCARD_S_SUCCESS</Status>
<Base64Data> </Base64Data>
</SmartcardResponse>
]]></DataFromPrinter></PrinterStatus>

Printer.SmartCardUnit:SingleWire:Disconnect
A Disconnect request terminates a connection previously opened between the calling application
and a smart card in the reader.

To terminate a connection, use the IBidiSpl interface with the schema set to
Printer.SmartCardUnit:SingleWire:Disconnect. For Java, call the SCard Disconnect method
of the Java helper DLL (dxp01sdk_IBidiSpl_interop.dll).
Smart Card Disconnect Request—Required Information

Your application must create an XML structure indicating the disconnect method to use. The
driver receives this XML formatted data as a BIDI_BLOB.
<?xml version=\"1.0\"?>
<!--smartcard disconnect xml-->
<SmartcardDisconnect>
<Method>SCARD_LEAVE_CARD</Method>
</SmartcardDisconnect>

Disconnect Method Value Action

SCARD_LEAVE_CARD Leave as is

SCARD_RESET_CARD Reset the card

SCARD_UNPOWER_CARD Power down the card

SDK Programmer’s Reference Guide 41

Smart Card Disconnect Request—Return Values
 The IBidiSpl interface returns a printer status XML structure. The printer status includes a
valid ClientID, WindowsJobID (if applicable, 0 for interactive mode jobs), PrinterJobID and
ErrorCode.
 If the ErrorCode is zero the request was successful.
 If the ErrorCode is non-zero the request failed. In this case, the printer status XML file
also contains values for ErrorSeverity and ErrorString.
 The CDATA section in the printer status XML structure returns any response from the smart
card reader.

Smart Card Disconnect Request—Status Returned

The following example shows a printer status XML structure returned by a single-wire smart card
Disconnect IBidiSpl request. The single-wire smart card reader response is included in the CDATA
section.
Sample XML file returned for disconnect
<?xml version="1.0"?>
<!--Printer status xml file.-->
<PrinterStatus>
<ClientID>Test-Win7_{716DD9A0-CF52-4176-B1C0-A10FA8DB055A}</ClientID>
<WindowsJobID>0</WindowsJobID>
<PrinterJobID>6049</PrinterJobID>
<ErrorCode>0</ErrorCode>
<ErrorSeverity>0</ErrorSeverity>
<ErrorString></ErrorString>
<DataFromPrinter><![CDATA[
<?xml version="1.0"?><!--smartcard response xml-->
<SmartcardResponse>
<Protocol> </Protocol>
<State> </State>
<Status>SCARD_S_SUCCESS</Status>
<Base64Data> </Base64Data>
</SmartcardResponse>
]]></DataFromPrinter></PrinterStatus>

Printer.SmartCardUnit:SingleWire:Transmit
A Transmit request sends a service request to the smart card and expects to receive data back
from the card.

To send a request, use the IBidiSpl interface with the schema set to
Printer.SmartCardUnit:SingleWire:Transmit. For Java, call the SCardTransmit
method of the Java helper DLL (dxp01sdk_IBidiSpl_interop.dll).

42 Interactive Mode Using the IBidiSpl Interface

Smart Card Transmit Request—Required Information

Your application must create a smart card transmit XML structure with the chip data encoded as
Base64 ASCII. The driver receives this XML formatted data as a BIDI_BLOB.
<?xml version=\"1.0\"?>
<!--smartcard transmit xml-->
<SmartcardTransmit>
<Base64Data>O/2RAP+RgXH+QABCAAAAAACBgYAXCACIGQ==</Base64Data>
</SmartcardTransmit>

Smart Card Transmit Request—Return Values

 The IBidiSpl interface returns a printer status XML structure. The printer status includes a
valid ClientID, WindowsJobID (if applicable, 0 for interactive mode jobs), PrinterJobID, and
ErrorCode.
 If the ErrorCode is zero, the transmit request was successful.
 If the ErrorCode is non-zero, the transmit request failed. In this case, the printer status
XML file also contains values for ErrorSeverity and ErrorString.
 The CDATA section in the printer status XML structure returns any response from the smart
card reader.

Smart Card Transmit Request—Status Returned

The following example shows a printer status XML structure returned by a single-wire smart card
Transmit IBidiSpl request. The single-wire smart card reader response is included in the CDATA
section.
<?xml version="1.0"?>
<!--Printer status xml file.-->
<PrinterStatus>
<ClientID>agarwas-Win7_{716DD9A0-CF52-4176-B1C0-A10FA8DB055A}</ClientID>
<WindowsJobID>0</WindowsJobID>
<PrinterJobID>6049</PrinterJobID>
<ErrorCode>0</ErrorCode>
<ErrorSeverity>0</ErrorSeverity>
<ErrorString></ErrorString>
<DataFromPrinter><![CDATA[
<?xml version="1.0"?><!--smartcard response xml-->
<SmartcardResponse>
<Protocol> </Protocol>
<State> </State>
<Status>SCARD_S_SUCCESS</Status>
<Base64Data>ZwA=</Base64Data>
</SmartcardResponse>
]]></DataFromPrinter></PrinterStatus>

SDK Programmer’s Reference Guide 43

Printer.SmartCardUnit:SingleWire:Status
A Status request provides the current status of the smart card in the reader. You can call it any
time after a successful call to SCardConnect and before a successful call to SCardDisconnect. It
does not affect the state of the reader or reader driver.

To retrieve the smart card status, use the IBidiSpl interface with the schema set to
Printer.SmartCardUnit:SingleWire:Status. For Java, call the SCardStatus method of the
Java helper DLL (dxp01sdk_IBidiSpl_interop.dll).
Smart Card Status Request—Return Values
 The IBidiSpl interface returns a printer status XML structure. The printer status includes a
valid ClientID, WindowsJobID (if applicable, 0 for interactive mode jobs), PrinterJobID, and
ErrorCode.
 If the ErrorCode is zero, the status request was successful.
 If the ErrorCode is non-zero, the status request failed. In this case, the printer status XML
file also contains values for ErrorSeverity and ErrorString.
 The CDATA section in the printer status XML structure returns any response from the smart
card reader.

Smart Card Status Request—Status Returned

The following example shows a sample printer status XML structure returned by a single-wire
smart card Status IBidiSpl request. The single-wire smart card response is included in the CDATA
section.
<?xml version="1.0"?>
<!--Printer status xml file.-->
<PrinterStatus>
<ClientID>agarwas-Win7_{716DD9A0-CF52-4176-B1C0-A10FA8DB055A}</ClientID>
<WindowsJobID>0</WindowsJobID>
<PrinterJobID>6049</PrinterJobID>
<ErrorCode>0</ErrorCode>
<ErrorSeverity>0</ErrorSeverity>
<ErrorString></ErrorString>
<DataFromPrinter><![CDATA[
<?xml version="1.0"?><!--smartcard response xml-->
<SmartcardResponse>
<Protocol>SCARD_PROTOCOL_RAW</Protocol>
<State>SCARD_PRESENT|SCARD_POWERED|SCARD_NEGOTIABLE</State>
<Status>SCARD_S_SUCCESS</Status>
<Base64Data>O/2RAP+RgXH+QABCAAAAAACBgYAXCACIGQ==</Base64Data>
</SmartcardResponse>
]]></DataFromPrinter></PrinterStatus>

44 Interactive Mode Using the IBidiSpl Interface

Printer.SmartCardUnit:SingleWire:GetAttrib
A GetAttrib request retrieves the current reader attributes. It does not affect the state of the
reader, driver, or card.

To retrieve the smart card reader attributes, use the IBidiSpl interface with the schema set to
Printer.SmartCardUnit:SingleWire:GetAttrib.

Smart Card GetAttrib Request—Required Information

Your application must create a smart card status XML structure with the name of the reader
attribute you want information for. The driver receives this XML formatted data as a BIDI_BLOB.
<?xml version=\"1.0\"?>
<!--smartcard get attrib xml-->
<SmartcardGetAttrib>
<Attr>SCARD_ATTR_VENDOR_IFD_VERSION</Attr>
</SmartcardGetAttrib>

AttribName Action

SCARD_ATTR_VENDOR_NAME Reader Vendor

SCARD_ATTR_VENDOR_IFD_ Vendor-supplied interface device version.

VERSION (DWORD in the form 0xMMmmbbbb where
MM = major version, mm = minor version, and
bbbb = build number)

SCARD_ATTR_VENDOR_IFD_TYPE Vendor-supplied interface device type (model

designation of reader)

SCARD_ATTR_VENDOR_IFD_SERIAL_ Vendor-supplied interface device serial number

NO

Smart Card GetAttrib Request—Return Values

 The IBidiSpl interface returns a printer status XML structure. The printer status includes a
valid ClientID, WindowsJobID (if applicable, 0 for interactive mode jobs), PrinterJobID, and
ErrorCode.
 If the ErrorCode is zero, the GetAttrib request was successful.
 If the ErrorCode is non-zero, the GetAttrib request failed. In this case, the printer status
XML file also contains values for ErrorSeverity and ErrorString.
 The CDATA section in the printer status XML structure returns any response from the smart
card reader.

SDK Programmer’s Reference Guide 45

Smart Card GetAttrib Request—Status Returned

The following is an example of a printer status XML structure returned by a single-wire smart card
GetAttrib IBidiSpl request. The single-wire smart card response is included in the CDATA section.
In this case, it is a request for the vendor name. The name is returned in the Base64Data element
as Base64 encoded ASCII and must be decoded by your application.
<?xml version="1.0"?>
<!--Printer status xml file.-->
<PrinterStatus>
<ClientID>agarwas-Win7_{716DD9A0-CF52-4176-B1C0-A10FA8DB055A}</ClientID>
<WindowsJobID>0</WindowsJobID>
<PrinterJobID>6049</PrinterJobID>
<ErrorCode>0</ErrorCode>
<ErrorSeverity>0</ErrorSeverity>
<ErrorString></ErrorString>
<DataFromPrinter><![CDATA[
<?xml version="1.0"?><!--smartcard response xml-->
<SmartcardResponse>
<Protocol> </Protocol>
<State></State>
<Status>SCARD_S_SUCCESS</Status>
<Base64Data> O/2RAP+RgXH+QABCAAAAAACBgYAXCACIGQ==</Base64Data>
</SmartcardResponse>
]]></DataFromPrinter></PrinterStatus>

Sample Code—Single-Wire Smart Card Personalization

For working code showing personalization of a smart card, refer to the following samples:
Visual C++, Visual C#, smartcard_singlewire
and VB.NET

Java SmartCard_singlewire.java

The SDK sample code wraps the IBidiSpl interface providing an interface that is similar to the
Microsoft Windows SCard API. You are welcome to include this code in your application or
communicate directly to the IBidiSpl interface, as you prefer.

46 Interactive Mode Using the IBidiSpl Interface

Read and Write Data to MIFARE Classic over
Single-Wire
An SDK sample is included that demonstrates how to read and write data to a MIFARE Classic chip
using Duali smart card reader commands over a single-wire smart card connection.

Sample Code—Single-Wire MIFARE Classic Smart Card

Personalization
For working code showing personalization of a smart card, refer to the following samples:
Visual C++, Visual C#, smartcard_singlewire_mifare
and VB.NET

Java Java does not support this feature at this time.

Return Values from the Sample Code SCard

Wrapper
Return values are provided by the printer as strings, but PC/SC applications expect a numeric
HRESULT value. The SDK wrapper code converts the return string to the HRESULT value expected
by the application. Possible return values are either SCARD_S_SUCCESS or an error. You can find
PC/SC error code information at: http://msdn.microsoft.com/en-us/library/ms936965.aspx

Application Responsibilities with Single-Wire

Smart Card
Your application must be able to do the following:
 Verify that the single-wire smart card reader is available in the printer. You can use the
IBidiSpl interface to get the printer options to do this.
 Park the smart card before using the single-wire smart card reader, and move the card out of
the reader when the personalization is complete.
 Send data the chip can accept. The driver does not check or alter the data.
 Format the data so it can be understood by the printer and reader.

Applications written for PC/SC readers require modification to use the single-wire smart
card feature. The PC/SC interface commonly used to interact with USB-connected smart
card readers is not directly supported by the driver API.

SDK Programmer’s Reference Guide 47

Laser Engraving
Your application can send data to the CL900 Desktop Laser Personalization System that can be
laser engraved on a card. The laser system requires additional setup and card design information
to be present on the laser system itself. Refer to the documentation for your laser system for
complete information about setting up the required files.

Retrieve Laser Card Setup Files

Using the IBidiSpl interface, your application can retrieve the laser card setup information in the
printer. This information is required to process the laser data.

To retrieve the names of all of the laser card setup files present in printer, your application calls
the IBidiSpl interface with the schema set to Printer.Laser:SetupFileName:Get.

The following example shows the XML structure that is returned with three laser card setup
names.
<?xml version="1.0" encoding="UTF-8"?>
<QuerySetupsResult>
<LaserCardSetups>
<LaserCardSetup name="TestCardSetup"/>
<LaserCardSetup name="TestCardSetup1"/>
<LaserCardSetup name="TestCardSetup2"/>
</LaserCardSetups>
</QuerySetupsResult>

Retrieve Laser Elements in a Setup File

The application also can retrieve the variable laser elements in a laser card setup file.

To retrieve element names of a laser card setup file present in the laser system, your application
calls the IBidiSpl interface with the schema set to Printer.Laser:ElementList:Get with the
laser setup file name as data.

The following example shows the XML structure of the TestCardSetup1 laser card setup file. The
setup file contains seven variable element names. The information returned for each element
includes the card side, the type of element, and the element name.
<?xml version="1.0" encoding="UTF-8"?>
<QueryElementsResult>
<ElementInformationList>
<ElementInformation side="FRONT" type="BINARY" name="PHOTO"/>
<ElementInformation side="FRONT" type="TEXT" name="GIVEN_NAME"/>
<ElementInformation side="FRONT" type="TEXT" name="FAMILY_NAME"/>
<ElementInformation side="FRONT" type="TEXT" name="DOB"/>
<ElementInformation side="FRONT" type="BINARY" name="SIGNATURE"/>
<ElementInformation side="BACK" type="TEXT" name="BARCODE_1D"/>
<ElementInformation side="BACK" type="BINARY" name="BARCODE_2D"/>
</ElementInformationList>
</QueryElementsResult>

48 Interactive Mode Using the IBidiSpl Interface

Use the Laser Sample
The flowchart illustrates the laser engraving process without
magnetic stripe encoding or printing.
The Laser sample program shows how to laser engrave three StartJob
types of laser layouts:
 Duplex card. The card is engraved on both sides with
variable data elements.
 Simplex card. The card is engraved on one side with variable Send laser card
data elements. setup file name

 Static card. The card is engraved with predefined data that

does not need variable elements. The static card can be
either single-sided or double-sided.
Send laser
The laser engrave data can be one of the following types: engrave bitmap
or text strings
 TEXT. A UTF-8 text string. This includes text strings and some
bar code formats. No

 BINARY. Base64-encoded binary data. This includes images

and bar codes. Sent all laser
engrave
The application must send the name of the laser card setup file. elements?
If the setup file contains variable elements, the application also
must send the variable data for each element to be engraved. Yes

A job that laser engraves a static layout would use the following
IBidiSpl operations in the order specified:
EndJob
1. Start Job—The printer starts the job and picks the card.

2. Specify the laser setup file—Specify the static laser setup

file name
3. End Job—The printer ejects the card into the output hopper.

SDK Programmer’s Reference Guide 49

 A job that engraves a duplex card layout with variable data elements would use the following
IBidiSpl operations in the order specified:
1. Start Job—The printer starts the job and picks the card.

2. Specify the laser setup file—Specify the duplex laser setup file name, and the variable
elements count.

3. Specify laser engrave data—Send text or binary information for all the variable elements in
the laser setup file.
4. End Job—The printer ejects the card into the output hopper.

The laser card layout file specifies the element name location and the card side. The
application does not have to specify where the element will be engraved.

A job that encodes a magnetic strip, prints text (depending on the printer capabilities), and laser
engraves data would use the following IBidiSpl operations in the order specified:
1. Start Job—The printer starts the job and picks the card.

2. Magnetic Stripe Encode—The application sends the magnetic stripe track data.
3. Print card side(s)—Use the Windows printing interface (for example, GDI, WinForms), not
IBidiSpl.
4. Wait for the print data to enter the spooler.

5. Specify the laser setup file—Specify the laser setup file name, and the variable elements
count.

6. Specify laser engrave data—Send text or binary information for all the variable elements in
the laser setup file.
7. End Job—The printer completes printing and then ejects the card into the output tray.

50 Interactive Mode Using the IBidiSpl Interface

Import or Export Laser Setup Files
Using the IBidiSpl interface, your application can transfer laser card setup files from one laser
system to another. To export the laser card setup files from the laser system, the driver returns a
zip file containing the setup files to the PC. The application then can import the zip file from the
PC to another laser system.

The zip file should not be modified by the application before importing it to another
system.

To export all the files related to a laser card setup from a system, your application calls the
IBidiSpl interface with the schema set to Printer.Laser:Upload:File:Get. The driver returns
the base64-encoded zip file from the system. The zip file contains all the items that are linked to
the specified laser setup file name, such as the ConCAD file, laser profiles, pattern match setup,
and so on.

To import the zip file containing the laser setup to a different system, your application calls the
IBidiSpl interface with the schema set to Printer.Laser:Download:File:Set.

The following XML is returned to your application when exporting or importing zip files from, or
to, a system:
<?xml version="1.0"?>
<!--laser response xml-->
-<LaserResponse>
<Status>1</Status>
<Base64Data> </Base64Data>
</LaserResponse>

Status Value Description

1 Action succeeded

0 Action failed

SDK Programmer’s Reference Guide 51

Installed Printer Status, Supplies Status, and
Counter Status
Your application can determine the status of the printer and which options are available in the
printer, information about the supplies loaded in the printer, and card counts.

Printer Status Information

To retrieve printer status, your application uses the IBidiSpl interface with the schema set to
Printer.PrinterOptions2:Read. For Java, call the GetPrinterOptions2 method of the
Java helper DLL (dxp01sdk_IBidiSpl_interop.dll).

The expanded list of printer information described in the following section requires
Printer.PrinterOptions2:Read.

The following shows a sample printer status XML file returned by this request.
<?xml version="1.0"?>
<!--Printer options2 xml file.-->
<PrinterInfo2>
<PrinterStatus>Ready</PrinterStatus>
<PrinterAddress>172.16.5.79</PrinterAddress>
<PrinterModel>CXXXX</PrinterModel>
<PrinterSerialNumber>C15133</PrinterSerialNumber>
<PrinterVersion>XX.XX.X-X</PrinterVersion>
<PrinterMessageNumber>0</PrinterMessageNumber>
<ConnectionPortType>Network</ConnectionPortType>
<ConnectionProtocol>Version2Secure</ConnectionProtocol>
<OptionInputhopper>SingleHopper</OptionInputhopper>
<OptionMagstripe>ISO</OptionMagstripe>
<OptionSecondaryMagstripeJIS>None</OptionSecondaryMagstripeJIS>
<OptionRewritable>None</OptionRewritable>
<OptionSmartcard>Single wire</OptionSmartcard>
<OptionDuplex>Auto</OptionDuplex>
<OptionPrinterBarcodeReader>None</OptionPrinterBarcodeReader>
<OptionLocks>Installed</OptionLocks>
<LockState>Locked</LockState>
<PrintEngineType>DirectToCard_DyeSub</PrintEngineType>
<PrintHead>Installed</PrintHead>
<ColorPrintResolution>300x300 | 300x600</ColorPrintResolution>
<MonochromePrintResolution>300x300 |300x600 |300x1200</MonochromePrintResolution>
<TopcoatPrintResolution>300x300</TopcoatPrintResolution>
<ModuleEmbosser>Installed</ModuleEmbosser>
<EmbosserVersion>E1.1.24-0</EmbosserVersion>
<Laminator>None</Laminator>
<LaserModule>Installed</LaserModule>
<LaserVisionRegistration>Installed</LaserVisionRegistration>
<ObscureBlackPanel>None</ObscureBlackPanel>
</PrinterInfo2>

52 Interactive Mode Using the IBidiSpl Interface

Printer Status

The PrinterStatus element contains the state of the printer at the time of the request. Your
application can use this to determine if the printer is online and ready to accept a job.

PrinterStatus Value Description

Unavailable The printer is not connected or is powered off.

Ready The printer is available to accept a job.

Busy The printer is processing a job.

Paused The printer has errors or has been paused.

Suspended The printer's front panel or Print Manager application is being

used.

Initialize The printer is powering up and not ready to accept a job.

Shutdown The printer is powering down and cannot accept a job.

Printer Information

Element Value Description

PrinterAddress The IP address of the network printer.

PrinterModel The model of the printer.

PrinterSerialNumber The serial number of the printer.

PrinterVersion The firmware version installed on the printer.

Message Number

The MessageNumber element contains the error number if the printer is in an error state. A value
of zero means there is no error. (Refer to Appendix A: "Error Description Strings” for a list of
messages.)

SDK Programmer’s Reference Guide 53

Printer Connection Information

Element Value Description

ConnectionPortType Identifies the physical connection being used to communicate

to the printers. The values are:
 Network

 USB

ConnectionProtocol Identifies the protocol used to communicate with the printer.

The values are:
 Version1

 Version2
 Version2Secure
Version2Secure is required if you want all the data exchanged
between the driver and printer to be encrypted.

Printer Options

Element Value Description

OptionInputhopper The input hopper configuration for this printer. The

values are:
 SingleFeed

 SingleHopper
 SingleHopperWithExceptionSlot
 MultiHopper6WithExceptionSlot
 HopperAutoDetect
Note: Printers that support hopper detection return the
value HopperAutoDetect for OptionInputHopper. Your
application then can use the IBidiSpl operation
Printer.Hopper:Status:Get to get the input hopper
status.

OptionMagstripe The magnetic stripe configuration for this printer. The

values are:
 None

 ISO
 JIS

54 Interactive Mode Using the IBidiSpl Interface

 Element Value Description

OptionRewritable Identifies if this printer supports rewritable cards. The

values are:
 None

 Installed
Note: For printers that support rewritable cards, the
rewritable feature must be enabled and the printer
configured correctly.

OptionSecondaryMagstripeJIS The secondary magnetic stripe configuration for the

printer. The values are:
 None

 Installed

OptionSmartcard The smart card configuration for this printer. The values
are:
 None

 Installed
 Single wire

OptionDuplex The duplex configuration for this printer. The values are:
 Manual

 Auto

OptionPrinterBarcodeReader Indicates if a bar code reader is installed. The values are:

 None

 Installed
Note: The CR805 retransfer printer cannot detect if a bar
code reader is installed in the printer. The value None is
returned even if the bar code reader is installed.

OptionLocks The lock configuration for this printer. The values are:
 None

 Installed

LockState The lock state if the printer has the lock option installed.
The values are:
 Locked

 Unlocked
This element is missing if the OptionLock value is None.

SDK Programmer’s Reference Guide 55

 Element Value Description

PrintEngineType The type of printer reporting the information. The values

are:
 DirectToCard_DyeSub

 Retransfer_Pigment

PrintHead Indicates if this printer includes a print head. (The

printer might not have a printhead if you are connected
to an emboss-only CE840 system.) The values are:
 None

 Installed

ColorPrintResolution The color printing resolutions supported by this printer.

This is a list of values separated by a "|" character. The
value list may include:
 300x300

 300x600
 600x600 (CR805 retransfer card printer only)
This element is missing if the PrintHead value is None.

MonochromePrintResolution The monochrome printing resolutions supported by this

printer. This is a list of values separated by a "|"
character. The value list may include:
 300x300

 300x600
 300x1200
 600x600 (CR805 retransfer card printer only)
This element is missing if the PrintHead value is None.

TopcoatPrintResolution The topcoat resolution supported by this printer. The

values are:
 300x300

 Unknown

ModuleEmbosser Indicates if this printer includes a CEM embosser. The

values are:
 None

 Installed

EmbosserVersion The embosser firmware version if the system includes an

embosser. The element is missing if the EmbossModule
value is None.

56 Interactive Mode Using the IBidiSpl Interface

 Element Value Description

Laminator Indicates if the printer includes a laminator and, if so,

whether it has one or two lamination stations. The
values are:
 None

 L1
 L1, L2

LaminatorFirmwareVersion The laminator firmware version if the system includes a

laminator. This element is missing if the Laminator value
is None.

LaminatorImpresser Indicates if the laminator includes the card impresser

option. The values are:
 None

 Installed

LaminatorScanner Indicates if the laminator includes the bar code scanner

option. The values are:
 None

 Installed

LaserModule Indicates if the laser module is installed. The values are:

 None

 Installed

LaserVisionRegistration Indicates if the Laser Vision module is installed. The

values are:
 None

 Installed

ObscureBlackPanel Indicates if the printer has the ability to obscure the

information printed with the K panel. The value None is
returned.

Sample Code—Printer Status

For working code showing printer status, refer to the following samples:
Visual C++, Visual C#, status
and VB.NET

Java PrinterStatusXML.java

SDK Programmer’s Reference Guide 57

Supplies Information
Your application can determine the status of supplies using the IBidiSpl interface with the schema
set to Printer.SuppliesStatus3:Read. For Java, call the GetPrinterSuppliesStatus method of
the Java helper DLL (dxp01sdk_IBidiSpl_interop.dll).

The request returns the supplies status XML file.

<?xml version="1.0"?>
<!--Printer Supplies3 xml file.-->
<PrinterSupplies3>
<PrinterStatus>Ready</PrinterStatus>
<Printer>
<PrintRibbon>Installed</PrintRibbon>
<PrintRibbonType>YMCKT</PrintRibbonType>
<RibbonRemaining>76</RibbonRemaining>
<RibbonSerialNumber>E0055000008D355F</RibbonSerialNumber>
<RibbonLotCode>10232016 </RibbonLotCode>
<RibbonPartNumber>535000003</RibbonPartNumber>
<RibbonRegionCode>0</RibbonRegionCode>
<RetransferFilmPartNumber>0</RetransferFilmPartNumber>
<RetranferFilmPercentRemaining></RetransferFilmPercentRemaining>
<RetransferFilmSerialNumber></RetransferFilmSerialNumber>
<RetransferFilmLotCode></RetransferFilmLotCode>
</Printer>
<Embosser>
<IndentRibbon>None</IndentRibbon>
<IndentRibbonType></IndentRibbonType>
<IndentRibbonRemaining></IndentRibbonRemaining>
<TopperRibbon>None</TopperRibbon>
<TopperRibbonType></TopperRibbonType>
<TopperRibbonRemaining></TopperRibbonRemaining>
<TopperRibbonSerialNumber></TopperRibbonSerialNumber>
<TopperRibbonLotCode></TopperRibbonLotCode>
<TopperRibbonPartNumber></TopperRibbonPartNumber>
</Embosser>
<Laminator>
<L1Laminate>Installed</L1Laminate>
<L1LaminateType>33624064</L1LaminateType>
<L1LaminateRemaining>65</L1LaminateRemaining>
<L1LaminateSerialNumber>e0055000008e7624</L1LaminateSerialNumber>
<L1LaminateLotCode>DPS 0913 </L1LaminateLotCode>
<L1LaminatePartNumber>508668901</L1LaminatePartNumber>
<L2Laminate>Installed</L2Laminate>
<L2LaminateType>34078720</L2LaminateType>
<L2LaminateRemaining>97</L2LaminateRemaining>
<L2LaminateSerialNumber>e0055000008e6c08</L2LaminateSerialNumber>
<L2LaminateLotCode>DPS 0913 </L2LaminateLotCode>
<L2LaminatePartNumber>508832901</L2LaminatePartNumber>
</Laminator>
</PrinterSupplies3>

58 Interactive Mode Using the IBidiSpl Interface

 Element Value Description

Printer

PrintRibbon Indicates if a print ribbon is installed. The values are:

 None

 Installed

PrintRibbonType The type of ribbon installed in the printer. The value

returned will be one of the supported ribbon types for
the printer, such as YMCKT, ymcKT, KT, FCMYP-KP, and so
on.

RibbonRemaining The amount of unused ribbon as a percent.

RibbonSerialNumber The serial number of the ribbon.

RibbonLotCode The lot code of the ribbon.

RibbonPartNumber The part number of the ribbon.

RibbonRegionCode The region code of the ribbon.

RetransferFilmPartNumber The part number of the retransfer film. Reported for the
CR805 retransfer card printer only.

RetransferFilmPercent The amount of unused retransfer film as a percent.

Remaining Reported for the CR805 retransfer card printer only.

RetransferFilmSerialNumber The serial number of the retransfer film. Reported for

the CR805 retransfer card printer only.

RetransferFilmLotCode The lot code of the retransfer film. Reported for the
CR805 retransfer card printer only.

Embosser

IndentRibbon If the system includes an embosser, this element

indicates if indent ribbon is installed. The values are:
 None

 Installed

IndentRibbonType The type of indent ribbon installed.

IndentRibbonRemaining The amount of unused indent ribbon as a percent.

SDK Programmer’s Reference Guide 59

 Element Value Description

TopperRibbon This element indicates if topping foil is installed. The

values are:
 None

 Installed

TopperRibbonType The type of topping foil installed in the printer. The

values are:
 Silver

 Gold
 Black
 White
 Blue

TopperRibbonRemaining The amount of unused topping foil as a percent.

TopperRibbonSerialNumber The serial number of the topping foil.

TopperRibbonLotCode The lot code of the topping foil.

TopperRibbonPartNumber The part number of the topping foil.

Laminator

L1Laminate Indicates if the laminator L1 station has a supply

installed. The values are:
 None

 Installed

L1LaminateType The universal supply code of the supply.

L1LaminateRemaining The amount of unused supply as a percent.

L1LaminateSerialNumber The serial number of the supply.

L1LaminateLotCode The lot code of the supply.

L1LaminatePartNumber The part number of the supply.

L2Laminate Indicates if the laminator L2 station has a supply

installed. The values are:
 None

 Installed

L2LaminateType The universal supply code of the supply.

60 Interactive Mode Using the IBidiSpl Interface

 Element Value Description

L2LaminateRemaining The amount of unused supply as a percent.

L2LaminateSerialNumber The serial number of the supply.

L2LaminateLotCode The lot code of the supply.

L2LaminatePartNumber The part number of the supply.

Sample Code—Supplies Status

For working code showing supplies status, refer to the following samples:
Visual C++, Visual C#, status
and VB.NET

Java PrinterSuppliesStatus.java

SDK Programmer’s Reference Guide 61

Card Counts
Your application can get the card count information and reset the printer’s resettable card
counts.
Get Card Counts
To get the card count information stored in the printer using the IBidiSpl interface, set the
schema to Printer.CounterStatus2:Read. For Java, call the GetPrinterCounterStatus2 method
of the Java helper DLL (dxp01sdk_IBidiSpl_interop.dll).

The request returns the supplies status XML file.

Status XML File for Single Input Hopper Printer
<?xml version="1.0"?>
<!--Printer counter2 xml file.-->
<CounterStatus2>
<PrinterStatus>Ready</PrinterStatus>
<CurrentPickedExceptionSlot>18</CurrentPickedExceptionSlot>
<TotalPickedExceptionSlot>18</TotalPickedExceptionSlot>
<CurrentPickedInputHopper1>328</CurrentPickedInputHopper1>
<TotalPickedInputHopper1>328</TotalPickedInputHopper1>
<CurrentPicked>346</CurrentPicked>
<TotalPicked>346</TotalPicked>
<CurrentCompleted>245</CurrentCompleted>
<TotalCompleted>245</TotalCompleted>
<CurrentRejected>84</CurrentRejected>
<TotalRejected>84</TotalRejected>
<CurrentLost>17</CurrentLost>
<TotalLost>17</TotalLost>
<CardsPickedSinceCleaningCard>226</CardsPickedSinceCleaningCard>
<CleaningCardsRun>5</CleaningCardsRun>
</CounterStatus2>

62 Interactive Mode Using the IBidiSpl Interface

Status XML for Six-Position Input Hopper Printer
<?xml version="1.0"?>
<!--Printer counter2 xml file.-->
<CounterStatus2>
<PrinterStatus>Ready</PrinterStatus>
<CurrentPickedExceptionSlot>3</CurrentPickedExceptionSlot>
<TotalPickedExceptionSlot>3</TotalPickedExceptionSlot>
<CurrentPickedInputHopper1>156</CurrentPickedInputHopper1>
<TotalPickedInputHopper1>156</TotalPickedInputHopper1>
<CurrentPickedInputHopper2>1</CurrentPickedInputHopper2>
<TotalPickedInputHopper2>1</TotalPickedInputHopper2>
<CurrentPickedInputHopper3>4</CurrentPickedInputHopper3>
<TotalPickedInputHopper3>4</TotalPickedInputHopper3>
<CurrentPickedInputHopper4>4</CurrentPickedInputHopper4>
<TotalPickedInputHopper4>4</TotalPickedInputHopper4>
<CurrentPickedInputHopper5>6</CurrentPickedInputHopper5>
<TotalPickedInputHopper5>6</TotalPickedInputHopper5>
<CurrentPickedInputHopper6>4</CurrentPickedInputHopper6>
<TotalPickedInputHopper6>4</TotalPickedInputHopper6>
<CurrentPicked>178</CurrentPicked>
<TotalPicked>178</TotalPicked>
<CurrentCompleted>170</CurrentCompleted>
<TotalCompleted>170</TotalCompleted>
<CurrentRejected>8</CurrentRejected>
<TotalRejected>8</TotalRejected>
<CurrentLost>0</CurrentLost>
<TotalLost>0</TotalLost>
<CardsPickedSinceCleaningCard>164</CardsPickedSinceCleaningCard>
<CleaningCardsRun>1</CleaningCardsRun>
</CounterStatus2>

Element Value Description

CurrentPickedExceptionSlot Number of cards picked from the exception slot. The

driver does not provide a means to select the exception
slot so this number is typically zero.

TotalPickedExceptionSlot Total number of cards picked from the exception slot.

CurrentPickedInputHopper1– Number of cards picked from the input hopper. For a

Current PickedInputHopper6 multi-hopper printer, the number of cards picked from
each hopper is returned. This can be reset at the printer
with proper permission.

TotalPickedInputHopper1– Total number of cards picked from the input hopper. For
TotalPickedInputHopper6 a multi-hopper printer, the total number of cards picked
from each hopper is returned.

CurrentPicked Number of cards picked by the printer. This can be reset

at the printer with proper permission.

TotalPicked Total number of cards picked by this printer.

SDK Programmer’s Reference Guide 63

 Element Value Description

CurrentCompleted Number of cards successfully completed by the printer.

This can be reset at the printer with proper permission

TotalCompleted Total number of cards successfully completed by the

printer.

CurrentRejected Number of cards that were rejected by the printer

because they failed or were canceled. This can be reset
at the printer with proper permission.

TotalRejected Total number of cards that were rejected by the printer

because they failed or were canceled.

CurrentLost A calculated value for the cards that were neither

completed nor rejected. This can be reset at the printer
with proper permission.

TotalLost Total number of cards that were neither completed nor

rejected.

CardsPickedSinceCleaningCard Number of cards the printer has picked since it was

cleaned. This resets when the first card is picked after
the printer has been cleaned.

CleaningCardsRun Number of cleaning cards that have been run through

the printer.

Reset Card Counts

To reset the resettable card count values stored in the printer using the IBidiSpl interface, set the
schema to Printer.ResetCardCount:Set.

This function is not available for Java.

Sample Code—Card Counts

For working code showing card counts, refer to the following samples:
Visual C++, Visual C#, status—Use to obtain card count information
and VB.NET printer_control—Use to reset card counts

Java PrinterCounterStatus.java

64 Interactive Mode Using the IBidiSpl Interface

Hopper Status
Your application can get the status of the input hoppers (whether or not cards are present in the
hopper) for the CR805 retransfer card printer.
Get Hopper Status

To get the hopper status for the printer using the IBidiSpl interface, set the schema to
Printer.Hopper:Status.Get.

The request returns the hopper status XML file.

Input Hopper Status XML File for a CR805 Retransfer Card Printer
<!-- For CR805 printer where hopper detection is available -->
<?xml version="1.0"?>
<HopperStatus>
<PrinterStatus>Ready</PrinterStatus>
<HopperDetection>Available</HopperDetection>
<HopperInformation Name="Exception" CardStock="CardStock1" Status="Cannot Detect"
Type="Input"/>
<HopperInformation Name="Hopper1" CardStock="CardStock1" Status="Cards Present"
Type="Input"/>
<HopperInformation Name="Hopper2" CardStock="CardStock1" Status="Cards Present"
Type="Input"/>
<HopperInformation Name="Hopper3" CardStock="CardStock1" Status="Empty"
Type="Input"/>
<HopperInformation Name="Hopper4" CardStock="CardStock1" Status="Empty"
Type="Input"/>
<HopperInformation Name="Hopper5" CardStock="CardStock1" Status="Empty"
Type="Input"/>
<HopperInformation Name="Hopper6" CardStock="CardStock1" Status="Empty"
Type="Input"/>
</HopperStatus>

The hopper status information retrieved from the printer depends on whether the
printer has a single hopper or a multi-hopper.
 For a multi-hopper printer, the firmware cannot detect if the exception hopper has a
card present. The status returned always will be “Cannot detect.”
 For a single-hopper printer, the firmware can detect if the exception hopper has a
card present. The status returned will be “Cards Present” or “Empty.”

SDK Programmer’s Reference Guide 65

Input Hopper Status XML File for a Non-Retransfer Printer

The hopper status is not available for a non-retransfer printer. The following XML shows the
information returned for a non-retransfer printer.
<!-- For non-retransfer printer where hopper cannot be detected. -->
<?xml version="1.0"?>
<HopperStatus>
<PrinterStatus>Ready</PrinterStatus>
<HopperDetection>Unavailable</HopperDetection>
<HopperInformation CardStock="" Status="" Type="" Name="None"/>
<HopperInformation CardStock="" Status="" Type="" Name="None"/>
<HopperInformation CardStock="" Status="" Type="" Name="None"/>
<HopperInformation CardStock="" Status="" Type="" Name="None"/>
<HopperInformation CardStock="" Status="" Type="" Name="None"/>
<HopperInformation CardStock="" Status="" Type="" Name="None"/>
<HopperInformation CardStock="" Status="" Type="" Name="None"/>
</HopperStatus>

Locking
If your printer is equipped with locks, your application can lock and unlock the printer, as well as
change the password needed to unlock the printer. The IBidiSpl requests used to do this are:
 Printer.Locks:ChangeLockState:Set
 Printer.Locks:ChangePassword:Set

Lock or Unlock the Printer

Your application must create an XML structure with the lock state and password. The driver
receives this XML formatted data as a BIDI_BLOB.
<?xml version="1.0"?>
<ChangeLocks>
<LockPrinter>%d</LockPrinter>
<CurrentPassword>%ls</CurrentPassword>
</ChangeLocks>

LockPrinter Value Description

1 Lock printer

2 Unlock printer

The CurrentPassword value must be set to the correct password to successfully lock or unlock the
printer.

66 Interactive Mode Using the IBidiSpl Interface

Change the Lock/Unlock Password

Your application must create an XML structure with the lock state and password. The driver
receives this XML formatted data as a BIDI_BLOB.
<?xml version="1.0"?>
<ChangeLocksPassword>
<LockPrinter>1</LockPrinter>
<CurrentPassword>test</CurrentPassword>
<NextPassword>abcd</NextPassword>
</ChangeLocksPassword>

Your application must supply both the correct CurrentPassword and the new password in the
NextPassword element.

LockPrinter is always set to 1. Changing the lock password locks the printer if it is
unlocked.

Password Rules

Use the following rules to make sure that the password is considered valid by the printer:
 A password must have at least 4 legal characters. Legal characters are:
 alphanumeric (English) (A–Z, a–z, 0–9)
 plus (+)
 slash (/)
 dollar sign ($)
 A password is case sensitive.
 Empty quotes "" are used to disable the locking password.
If the printer is configured to not require a password, the printer locks or unlocks ignoring
whatever password is sent.
 When the locking password is changed, the NextPassword value becomes the
CurrentPassword for the next attempt to lock or unlock the printer.
When you send empty quotes ("") as the NextPassword value, the printer no longer requires
a password to lock or unlock.

SDK Programmer’s Reference Guide 67

Determine the Success of a Lock Request

For both lock requests, the status is returned in another XML structure. The following is an
example of an attempt to lock a printer that does not have locks installed.
<?xml version="1.0"?>
<!--Printer status xml file.-->
<PrinterStatus>
<ClientID>agarwas-Win7_{32DCD216-3B4E-4806-9661-3F80D6D99F72}</ClientID>
<WindowsJobID>0</WindowsJobID>
<PrinterJobID>0</PrinterJobID>
<ErrorCode>511</ErrorCode>
<ErrorSeverity>2</ErrorSeverity>
<ErrorString>Message 511: Cannot lock or unlock the printer. Locks are not
installed.</ErrorString>
<DataFromPrinter><![CDATA[ ]]></DataFromPrinter>
</PrinterStatus>

Sample Code—Locking
For working code showing the lock operation, refer to the following samples:
Visual C++, Visual C#, locks
and VB.NET

Java Java does not support locking at this time.

68 Interactive Mode Using the IBidiSpl Interface

Activate or Deactivate the Printer
Your application can activate or deactivate the printer when it will be out of service and you want
to guarantee that it is not used to produce cards. The printer can be activated later to re-enable it
for card production. The IBidiSpl request used to do this is Printer.ActivatePrinter:Set.

Your application must create an XML structure with the activation state and password. The driver
receives this XML formatted data as a BIDI_BLOB.
<?xml version="1.0"?>
<ActivatePrinter>
<Activate>%d</Activate>
<Password>%ls</Password>
</ActivatePrinter>

Activate Value Description

1 Activate printer

0 Deactivate printer

 To deactivate the printer, the password value must be set to the valid password.
 To activate the printer, the password value must match the password that was used to
deactivate the printer.

Caution: If the password used to deactivate the printer is lost, the printer cannot
be returned to the activated state. The printer must be replaced.

 The password is reset when the printer is activated. This allows the application to use any
valid password to deactivate the printer in the future.
 When a deactivate command is successful, the printer’s front panel LCD displays Print Job
queue is deactivated. A driver SDK status action returns the PrinterStatus as unavailable.
 If the command contains an invalid password, the SDK returns a 500 in the ErrorCode
element of the returned PrinterStatus structure.

Refer to “Locking” on page 66 for more information about setting or changing the password.

Sample Code—Activate or Deactivate Printer

For working code showing the activate or deactivate operation, refer to the following samples:
Visual C++, Visual C#, locks
and VB.NET

Java Java does not support printer activation or deactivation at this

time.

SDK Programmer’s Reference Guide 69

Change the Printer State
Your application can change the printer state to Online, Offline, or Suspended. An application can
print only when the printer state is Online. You can run maintenance operations when the printer
state is Suspended. A printer that is Offline cannot be used. The IBidiSpl request used to do this
is: Printer.ChangePrinterState:Set.

Your application must create an XML structure with the printer state. The driver receives this XML
formatted data as a BIDI_BLOB.
<?xml version="1.0"?>
<ChangePrinterState>
<State>%d</State>
</ChangePrinterState>

State Value Description

0 Online

1 Suspended

2 Offline

Sample Code—Change the Printer State

For working code showing the printer state operation, refer to the following samples:
Visual C++, Visual C#, printer_state
and VB.NET
Java Java does not support changing the printer state at this time.

Restart the Printer

Your application can restart a printer using the IBidiSpl interface with the schema set to
Printer.Restart:Set.

Sample Code—Restart Printer

For working code showing a printer restart, refer to the following samples:
Visual C++, Visual C#, printer_control
and VB.NET

Java Java does not support restart printer at this time.

70 Interactive Mode Using the IBidiSpl Interface

Interactive Mode Best Practices
 When interactive mode operations are used for card personalization, the driver will not
accept a job until the interactive operations for the active job complete. It is the
responsibility of your application to manage the card production queue and retry a job if the
job request is denied because another job is active. Refer to “Start and End an Interactive
Job” on page 24.
 Your application should always verify that the printer is online before starting a job. Refer to
“Installed Printer Status, Supplies Status, and Counter Status” on page 52 for information
about how to request and interpret the printer status to determine if the printer is online.

 Your application should always check the Printer Status returned by an IBidiSpl request to
determine if the request succeeded or failed.
 When recovering from an error while in interactive mode, always use the PrinterJobID value
returned by the Start Job request. The currently active job in the printer will be canceled if
your application sends a cancel action with a printer job ID of 0. Unless this printer is
dedicated to your application, the currently active job may not be the job you intend to
cancel.

SDK Programmer’s Reference Guide 71

72 Interactive Mode Using the IBidiSpl Interface
Appendix A: Error Description
Strings

Message Description

100 Request not supported

101 Job could not complete

102 Card not in position

103 Printer problem

104 Critical problem

105 Magstripe data error

106 Magstripe data not found

107 Magstripe read data error

108 Magstripe read no data

109 Print ribbon problem

110 Print ribbon out or missing

111 Card not picked

112 Card hopper empty

113 Close cover to continue

114 Cover opened during job

116 Magstripe not available

117 Reader not available

SDK Programmer’s Reference Guide A-1

 Message Description

118 Print ribbon type problem

119 Print ribbon not supported

120 User paused the printer

121 Print ribbon not identified

122 Magstripe format problem

123 Insert new card side 1 up

124 Insert same card side 2 up

125 Emboss critical error

126 Emboss format error

127 Emboss transport error

128 Embosser card jam

129 Embosser topper jam

130 Embosser card entry jam

131 Embosser card exit jam

132 Embosser card stack full

133 Embosser card reject full

135 Indent ribbon supplies out

136 Indent ribbon break

137 Embosser wheel error

138 Embosser indent error

139 Lost card, open emboss cover

140 Embosser not available

141 Close emboss cover

142 Emboss cover error

A-2 Error Description Strings

 Message Description

143 Topping foil problem

144 Topping foil out

145 Topping foil type problem

146 Topping foil support err

147 Topping foil no tag found

149 Option not installed

150 Print while unlocked

151 Failed to lock

152 Insert new card side 2 up

153 Insert same card side 2 up

166 C2 supply out or missing

167 C2 supply not identified

168 C2 supply not supported

170 Insert new card side 1 up

171 Insert same card side 1 up

172 Insert cleaning card

173 Improper shutdown

175 C2 supply error

176 C2 supply type error

177 Laminator not available

196 Laminator error critical

197 Laminator entry card problem

198 L1 area card problem

199 L2 area card problem

SDK Programmer’s Reference Guide A-3

 Message Description

200 Laminator exit card problem

201 L1 supply problem

202 L1 supply out or missing

203 L1 supply type problem

204 L1 supply not supported

205 L1 supply not identified

206 L2 supply problem

207 L2 supply out or missing

208 L2 supply type problem

209 L2 supply not supported

210 L2 supply not identified

211 L1 heater problem

212 L2 heater problem

213 L1 heater sensor problem

214 L2 heater sensor problem

215 L1 heater roller problem

216 L2 heater roller problem

217 Debow problem

218 Impresser problem

219 Impresser sensor problem

220 Impresser heater problem

221 Bar code scanner problem

222 Firmware version mismatch

223 Laminator system mismatch

A-4 Error Description Strings

 Message Description

224 Supply region not valid

225 Rewrite config mismatch

227 C2 waiting for roller temp

228 C1 printhead error

229 C2 heat sensor error

230 C2 heater error

231 C2 heated roller motion error

232 Retransfer debow error

233 Smart card contact fail

234 K1 transport card jam

235 K2 transport card jam

236 Flipper module rotate error

237 C1 supply out or missing

238 C1 supply not identified

239 C1 supply not supported

240 C1 supply error

241 C1 supply type error

242 RT1 reject tray full

243 Card lost

245 Configuration error

250 Card indexer error

251 Laser position error

252 Laser template error

253 Laser horizontal data error

SDK Programmer’s Reference Guide A-5

 Message Description

254 Laser not available

255 Laser cover open

256 Laser interlock open

257 Laser air filter missing

258 Laser not detected

259 Laser firmware error

260 Laser control error

261 Laser option not supported

262 Vision operation failed

263 Laser power board error

264 Lost card in laser

265 Laser card entry jam

266 Laser card exit jam

267 Laser hardware failure

268 Laser setup error

269 Laser setup name length error

270 Laser text length error

271 Laser card output full

272 Laser card reject full

273 Laser output area error

274 Vision not available

275 Multi-hopper error

276 Multi-hopper card jam

277 Multi-hopper pick error

A-6 Error Description Strings

 Message Description

500 The printer is not available

501 The printer connection was lost

502 The card data is missing or is not usable

504 The card data is missing or is not usable

505 USB communication issue

506 A card is currently processing

507 The printer is unlocked

508 The printer is shutting down

509 The printer is offline or suspended

510 The printer is unlocked

511 Cannot lock or unlock the printer. Locks are not installed.

512 Cannot lock or unlock the printer. The password is incorrect or

invalid.

513 Cannot lock or unlock the printer. The printer is busy.

514 Cannot lock or unlock the printer. The cover is open.

515 Failed to lock or unlock the printer. The locks did not function.

516 Timeout expired before bar code could be read.

517 Wrong printer job ID.

518 Unable to print.

519 File import failed.

520 Hopper number not valid.

521 Start job failed.

522 Failed to read laser files.

SDK Programmer’s Reference Guide A-7

A-8 Error Description Strings
Appendix B: Using the Java
SDK Sample Code with
Eclipse

The XPS Driver SDK Java samples work with either the 32- or 64-bit Java runtimes. Make sure a
Java runtime is installed on your computer.

1. To see if the Java runtime is installed, issue the command 'java -version' from a command
line. The following example shows the type information that displays:
C:\Users\fellmad>java -version

java version "1.7.0_xxx"

Java(TM) SE Runtime Environment (build 1.7.0_xxx-xxx)
Java HotSpot(TM) Client VM (build 25.xxx=xxx, mixed mode, sharing)

2. Extract the XPS Driver SDK zip file to a folder. For example: D:\java\xps_driver_sdk:
d:\java\xps_driver_sdk>dir
Directory of d:\java\xps_driver_sdk
07/04/2017 03:55 PM <DIR> doc
11/02/2016 01:46 PM 117,601 ReadMe.mht
10/28/2016 04:05 PM 406,891 Readme.pdf
08/04/2017 03:55 PM <DIR> samples
07/06/2017 03:51 PM 32,569,617 XPS_Card_Printer_SDK.zip

3. Start Eclipse and create a new workspace.

SDK Programmer’s Reference Guide B-1

 4. Import the SDK samples.
a. Select File | Import and Existing Projects into Workspace.

B-2 Using the Java SDK Sample Code with Eclipse

 b. Click Next.

c. Browse to the samples\java folder under the folder you created in Step 1.
d. Click Finish.

5. Create a runnable JAR file.

a. In the Eclipse Package Explorer, select com.sun.jna.examples.
b. Right-click com.sun.jna.examples and select Run As, then Java Application.

SDK Programmer’s Reference Guide B-3

 c. Create a runnable JAR file using File | Export and selecting Java- | Runnable JAR File:

B-4 Using the Java SDK Sample Code with Eclipse

 d. When prompted, select XPS_Java_SDK - xps driver sdk samples for the Launch
configuration. For the JAR filename, use dxp01Java_SDK.jar:

This creates a JAR file in the location you specify:

d:\java\xps_driver_sdk\samples\java>dir
Directory of d:\java\xps_driver_sdk\samples\java
03/04/2017 04:19 PM <DIR> dxp01Java_SDK
03/04/2017 04:28 PM 1,033,154 dxp01Java_SDK.jar
03/04/2017 03:55 PM <DIR> Library

e. Run the JAR file with no parameters to get help and to see the command line options:
d:\java\xps_driver_sdk\samples\java>java -jar dxp01Java_SDK.jar
…
-n <printername>. Required. Try -n "xps card printer"
-p Print [l][d][e][number]
-mr Magnetic stripe read [p][l][d]
-me Magnetic stripe encode [mr][p][l][d]
-sc Park a smart card [me][p][l][d][b]
…

SDK Programmer’s Reference Guide B-5

B-6 Using the Java SDK Sample Code with Eclipse
Appendix C: Suppressing the
Driver Message Display

If you want your application to present printer and driver messages to the user and resolve errors
directly, you can suppress the display of messages by the driver. This is known as “silent mode.”

Enabling Driver Silent Mode

1. Silent mode is enabled when the following registry setting is present and the data is set
correctly. This registry key must be created manually.

Key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Print\Printers

Value Name DXP01SilentMode

Value Type REG_DWORD

Data 1 = enable, any other value disable

2. The driver checks the DXP01SilentMode setting at startup.

To guarantee that the setting takes effect, restart the computer after you create or
modify the registry setting.

SDK Programmer’s Reference Guide C-1

Silent Mode Operation Notes
 Enabling silent mode causes suppression of pop-up messages for all instances (printers) of
the XPS Card Printer driver for all user accounts on the system.
 The SDK application can retrieve the error message any time using dxp01sdk:PRINTER_
MESSAGES. In addition, most of the SDK calls include printer errors as part of the status
information returned to the application.
 The application can cancel jobs using the SDK, including canceling all jobs in the printer.
When “cancel all jobs” is requested, the printer will cancel all of its jobs. The driver will also
cancel all the driver jobs that are in an error state.

The printer operator can cancel the job using the LCD panel. When this happens,
an error is removed from the driver automatically. Make sure that the application
accounts for this possibility.

 When the error is a driver condition (a 500-level message), the application must resolve the
error because the printer operator won’t be aware of the issue (the printer does not issue an
error). The driver will not process the next job until the 500-level message is resolved. The
application can either use “cancel all jobs” to cancel the job, or it can issue job-specific cancel
or resume commands to recover from the error.

C-2 Suppressing the Driver Message Display

Appendix D: Print a UV Photo

Printing a photo with the UV panel of the ribbon is a special case of monochrome printing.
However, unlike printing that uses the K panel, the UV ink is lighter than the card background
when illuminated with a UV light source (it becomes the white in the image). Because of this, a
photo printed using the UV panel must reverse the pixel values of the 1-bpp photo image (that is,
you need to use the negative of the image).

You can use IRFanView (http://www.irfanview.com/) to modify a color photo to print properly
using the UV panel.
1. Open the image you want to modify using IRFanView.

SDK Programmer’s Reference Guide D-1

 2. Select Decrease Color Depth from the Image menu and then select the following options in
the Decrease color depth dialog box.
 2 Colors (black/white) (1 BPP)
 Use Floyd-Steinberg dithering (for max 256 colors)

3. Click OK.
This changes the image so that it looks like the following:

D-2 Print a UV Photo

 4. Select Negative (invert image) from the Image menu.
The image then looks like the following. This step is required because the UV ink becomes the
“white” of the image when exposed to a UV light source.

5. Select Replace Color from the Image menu. Replace the source color (black) with the new
color (RGB:217,217,217) in the Replace Color dialog box. The Card Printer Driver recognizes
217:217:217 as the UV “color” and prints those elements using the UV panel of the ribbon.

SDK Programmer’s Reference Guide D-3

 6. Click OK.
The image now looks like the following. The black pixels in the image have been replaced
with 217:217:217.

7. Save the converted image as a .PNG file.

 When you use the modified image, be careful not to transform it in any way that
might introduce other colors into the image.
 Some images, such as a logo, might display better if they are not reversed.

D-4 Print a UV Photo

Appendix E: References

With Microsoft .NET Framework, application developers have a rich set of printing and print
system management APIs. At the core of this functionality is the XPS print path. The following link
provides an overview of XPS Windows printing:

https://docs.microsoft.com/en-us/dotnet/framework/wpf/advanced/printing-overview

A PrintTicket defines the settings of a print job. A PrintTicket object is an easy-to-work-with

representation of a certain type of XML document called a PrintTicket document. The following
link explains more about PrintTicket class:

https://msdn.microsoft.com/en-us/library/system.printing.printticket.aspx

You can download Print Schema and XML Paper Specifications using the following link:

https://msdn.microsoft.com/en-us/library/windows/hardware/dn614032(v=vs.85).aspx

Windows has improved bidirectional printer communication (Bidi communication), starting with
Windows XP. This allows drivers and applications to make requests to, and get responses from, a
printer device. The following link explains more about Bidi printer communication:

https://msdn.microsoft.com/en-us/ff545157

The IBidiSpl interface allows an application to send a Bidi request to the printer. The following link
explains more about the IBidiSpl interface:

https://msdn.microsoft.com/en-us/library/dd144980

SDK Programmer’s Reference Guide E-1

E-2 References