Entrust SR200 User manual

SR200 & SR300 Card Printer:
SDK Guide
539903-001 Rev. B
November 2010

SR200 & SR300 Card Printer SDK Guide
ii
Notice
See the “Software License Agreement” on the SR200 & SR300 Support CD. You must agree to the terms
of the agreement before you can legally use the software interface and this document.
Entrust shall not be responsible for anything developed by the use of the documents. Microsoft,
Windows and Windows Vista are either registered trademarks or trademarks of Microsoft
Corporation in the United States and/or other countries. In this book, the names for Microsoft®Windows®
XP operating system and Microsoft®Windows®2000 operating system are written as Windows XP and
Windows 2000 respectively. The Microsoft®Windows Vista®operating system is written as Windows
Vista.
AAMVA™ is a registered trademark of the American Association of Motor Vehicle Administrators.
The design and information contained in these materials is protected by U.S. and international copyright
law.

SR200 & SR300 Card Printer SDK Guide
iii
Revision History
June 2010
First release for SR200/SR300 printer and driver.
November 2010
Updates for driver that includes Windows 7, 64-bit, and current information
for laminator interface.

SR200 & SR300 Card Printer SDK Guide
iv
Contents
Introduction...........................................................................................................................1
Overview........................................................................................................................1
Control Libraries................................................................................................1
Operating Environment..................................................................................................1
System Configuration...........................................................................................................2
About the API .......................................................................................................................3
Command Structure.......................................................................................................3
Card Position.................................................................................................................3
Print Area.......................................................................................................................3
Printer Control Functions......................................................................................................4
Return Codes from Functions........................................................................................4
Process Flow to Issue the Card.....................................................................................5
Scan Printer Functions...................................................................................................6
Scan Function...................................................................................................6
Printer Check Function.....................................................................................6
Printer Status Functions .................................................................................................7
Test Unit Ready Function.................................................................................7
Read Position Function.....................................................................................7
Print on Retransfer Film functions..................................................................................8
Image Out Function..........................................................................................8
Define LUT Function.......................................................................................11
Print Function..................................................................................................12
Functions for Moving and Discharging the Card..........................................................13
Card Load Function........................................................................................13
Card Move Function .......................................................................................14
Retransfer to Card Functions ........................................................................................15
Retransfer Functions .......................................................................................15
Magnetic Stripe Encoding Functions...........................................................................16
Writing Function (for JIS)................................................................................16
Reading Function (for JIS)..............................................................................17
Writing Function (for ISO)...............................................................................17
Reading Function (for ISO).............................................................................19
SmartCard (IC) Function.............................................................................................20
IC Control Function.........................................................................................20
Initializing the Printer Function.....................................................................................20
Rezero Function..............................................................................................20
Functions for Getting Information & Changing Settings...............................................21
Inquiry Function..............................................................................................21
Mode Sense Function.....................................................................................22
Mode Select Function.....................................................................................32
Log Sense Function........................................................................................43
Log Select Function........................................................................................51
How to Encode with the Printer Driver ...............................................................................52
Inline Encoding............................................................................................................52

SR200 & SR300 Card Printer SDK Guide
v
Encoding with ExtEscape()..........................................................................................54
Smart Card (IC) Programming ......................................................................................55
How to Override Driver Settings.........................................................................................57
Using ExtEscape() to Override a Setting.....................................................................57
ExtEscape() Function ......................................................................................57
Change a Setting............................................................................................57
Get the Current Setting...................................................................................58
Programming Sample..................................................................................................59
cbParameterValues.......................................................................................61
Errors returned ................................................................................................62
Appendix A: API Error Codes.............................................................................................63
Error Format.................................................................................................................63
Driver Errors (0x02xxxxxx)...........................................................................................64
Other Errors (0x09xxxxxx)...........................................................................................64
Appendix B: Magnetic Stripe Data......................................................................................65
Appendix C: Card Printer Error Codes...............................................................................68

SR200 & SR300 Printer SDK Guide
Page 1
Introduction
Overview This document explains the application programming interface (API) for the SR200
& SR300 printer drivers.
Use the information to develop applications that use the SR200 printer or the
SR300 printer. When you install the printer driver, the Printer Control DLL, required
for the API (and printer driver), is also installed. You can use the printer driver and
an existing application to print and encode. You can also use the Printer Control
DLL directly without using the printer driver. This guide explains how to use Printer
Control DLL, and how to do smart card and magnetic stripe encoding with printer
driver.
Control Libraries
For the SR200/SR300 printer, the Printer Control DLL (PCP21CT.DLL) is part of
the USB driver. The API for the SR200/SR300 described in this document can be
used only with the USB driver and a USB connection.
The DLL is installed as part of driver installation.
Operating Environment
The following table shows the supported operating environment of the printer driver
and API.
Item
Contents
Note
Operating
System
Windows 7 (32-bit and 64-bit)
Windows Vista (Service Pack 1 or later, 32 bit only)
Windows 2000 Professional (Service Pack 4 or later, 32 bit)
Windows XP Professional (Service Pack 2 or later, 32 bit only)
Windows Server 2003 (R2 Service Pack 2 or later, 32 bit only)
Peripheral
SR200 or SR300 Card Printer
Connect the card
printer to the PC
with a USB cable.
The API uses the C programming language.

SR200 & SR300 Printer SDK Guide
Page 2
System Configuration
The following diagram shows the software components and their relationships.
Items with a gray background are not included with the SR200 or SR300 printer
and Support CD. Software components with a white background are installed from
the Support CD.
Tips for success
♦ Typically, the printer driver causes the printer to pick the card, and then
encodes and prints. If a card is already in the printer, the printer driver
processing is done to the card in the printer. By using the Printer Control DLL,
you can perform processes such as smart card encoding before the printer
driver’s process.
♦ If you use both the Printer Control DLL and the printer driver, disable the
Windows Spooler. The Printer Control DLL controls the card printer directly,
and can cause conflicts with any printing data in the spooler.

SR200 & SR300 Printer SDK Guide
Page 3
About the API
This section provides background information about the printer driver API.
Command Structure
The structure of a command to the printer is according to the SCSI rule. A printer
connected a PC is specified by both the Slot number and the ID of the printer. It
makes it possible to control up to 10 printers. Most functions require both the Slot
number and ID to specify the printer. The Slot number is a value decided by the
system environment, and the ID is the unit number of the printer minus 1 (one).
Card Position
The card must be in the correct position when you issue a printer command. If it is
not, the command might fail. For example, the card must be at the retransfer
position when you issue the Retransfer command, which retransfers the image
from the INTM film to the card. You can use the Read Position command to identify
the card position before issuing a command. The following table explains the card
positions.
Card Position
Explanation
Retransfer Position
The position to start Retransfer
Contact IC encoder position
The position to do Contact IC encoding.
No-Contact IC encoder position
The position to do No-Contact IC encoding.
MAG encoder position
The position to do MAG encoding.
Print Area
The printer uses the Retransfer method, which prints on the retransfer (INTM) film
and then the printer transfers the image to the card. The print area on the
Retransfer film is larger than the actual print area on the card, as shown below.
(0, 0)
0±0.5mm
Print area (1035, 663)
87.5mm (1036 Pixels)
1.0±0.5mm
1.
Thedirection of printing
on the film.
85.6mm
56.0mm (664 Pixels)
54.0mm

SR200 & SR300 Printer SDK Guide
Page 4
Printer Control Functions
The Printer Control DLL (a Windows DLL) supports the printer control functions.
The DLL is installed when the printer driver is installed.
Name
File Name
Explanation
Printer Control DLL
PCP21CT.DLL
SR200/SR300 CONTROL DLL for USB and 32-bit
operatingsystems
PCP21CT64>DLL
SR200/SR300 CONTROL DLL for USB and 64-bit
operatingsystems
Return Codes from Functions
All functions can return the following:
♦ 0 Success.
♦ Positive value: The command could not be run but the condition will recover
automatically. Retry after a little waiting. Possible values are:
1(_BUSY) The Port Manager did not send the command to the printer because
of the printer’s condition.
2(_TARGET_BUSY1) The Card Printer rejected the command because the
printer is moving the card.
3(_BUS_BUSY) The Printer Control DLL rejected the command because the
command issued by another process is being processed.
4(_TARGET_BUSY2) The Card Printer rejected the command because it is
printing on the retransfer film.
5(_TARGET_BUSY3) The Card Printer rejected the command because of both
_TARGET_BUSY1 and _TARGET_BUSY2.
♦ A negative value means an error occurred. See Appendix A: API Error Codes
for details.
There might be additional return codes from some functions, which are described
with the function.

SR200 & SR300 Printer SDK Guide
Page 5
Retransfer & Eject
Card Load *
Image Out
Scan Printer
Print
Image Out
Retransfer & Turn *
Card Move
MG Writing
Card Move
IC Control
Print *
Commands marked * should set
the Immediate flag to On so
mechanical and data actions
happen in parallel. With
Immediate set to On, the
command ends after the
command is accepted by the
printer so the software can take
the next action, such as sending
the image.
Each group of items inside a
dashed-line box is optional.
The diagram shows some but
not all card positioning
commands. You must position
the card at the correct location
for each command.
If errors occur before Retransfer
and Eject, the card is
discharged from the Reject
Card Slot. Only the Retransfer
command ejects the card to the
card stacker (or laminator, if
used).
Process Flow to Issue the Card
First, use the Scan Printer function to obtain the Slot number and ID of the printer.
When you have these values, you can use them to send commands to the printer.
The following diagram shows the typical flow for card processing.
You can use a different order if needed by your card design.

SR200 & SR300 Printer SDK Guide
Page 6
Scan Printer Functions
The API includes the following
♦ Scan Function
♦ Printer Check Function
Scan Function
No.
Function Name
Explanation
1
intCXCMD_ScanPrinter
(int *piSlot, int *piID)
Search for the first printer, and return the Slot
number and ID. The result is set at piSlot and piID.
2
intCXCMD_ScanPrinterNext
(int *piSlot, int *piID)
Search for additional SR200/SR300 printers, after
the one specified by piSlot and piID. The result is
set at piSlot and piID.
You do not need to retry these commands, even if they return a positive value. A
valid value is set at piSlot and piID even if they return a positive value. See Return
Codes from Functions for return values.
Printer Check Function
No.
Function Name
Explanation
1
BOOL
CXCMD_CheckIfConnected
(int *piSlot, int *piID)
Check whether the printer specified by the Slot
number and ID is connected or not. It returns TRUE
if it is connected and it returns FALSE if it is not.
This is the safest way to confirm whether the printer
is connected or not.

SR200 & SR300 Printer SDK Guide
Page 7
Printer Status Functions
You can use the following functions to retrieve printer status:
♦ Test Unit Ready Function
♦ Read Position Function
Test Unit Ready Function
No.
Function Name
Explanation
1
intCXCMD_TestUnitReady
(int iSlot, int iID)
Check the printer condition by issuing Test Unit
Ready command to the printer.
Read Position Function
No.
Function Name
Explanation
1
intCXCMD_ReadPosition
(int iSlot, int iID,
BYTE *pbyBuffer)
Retrieve the card position by issuing Read Position
command to the printer. The data is set at pbyBuffer.
Data Format for the Read Position Function
Bit
Byte
7
6
5
4
3
2
1
0
0
Reserved
PU*
Reserved
1
Reserved
Load
Mode**
From 2 to 6
Reserved
7
Position***
The following are possible values in the pbyBuffer data returned:
*PU (Position Unknown) values can be:
0: A card is in the printer unit.
1: No card is in the printer unit.
The printer reports PU = 1 if cards are only in the card hopper. The printer
generates a Check Condition if it is transporting the card.
**Load Mode is the way to load the card, and can be:
0 From the card tray
***Position is the card position in the printer unit, and can be:
0 At Retransfer Position
1 At Contact IC Encoder
2 At No-Contact IC encoder
3 At MAG encoder
Greater than 3 Reserved

SR200 & SR300 Printer SDK Guide
Page 8
Y Plane
M Plane
C Plane
BGR pixel map
Print on Retransfer Film functions
The API provides the following printing functions:
♦ Image Out Function
♦ Define LUT Function
♦ Print Function
Image Out Function
No.
Function Name
Explanation
1
intCXCMD_ImageOut
(int iSlot, int iID,
BYTE * pbyPlane,
int iLength,
int iColor,
int iBuffer)
Transfers image data to the printer by using Image Out
command.
pbyPlane Image Data. The size of image data must be
1036 x 664 bytes.
iLength Size of image data in bytes, which must be 1036 x
664.
iColor Kind of image data.
0 if image data is for K (black) ink.
1 if image data is for C (Cyan or blue) ink.
2 if image data is for M (Magenta) ink.
3 if image data is for Y (Yellow) ink.
4 if image data is for UV ink.
5 if image data is for Peel Off.
iBuffer Image Data buffer number. The printer has two
image buffers for all images. Specify:
0 to use Buffer 0.
1 to use Buffer 1.
How to Translate RGB to YMC Planes
The SR200 & SR300 printers support printing to YMC planes to print a colored
image. If the source image is in RGB format, it must be transformed to Y, M and C
planes. Normally, the formula to translate RGB to YMC is as follows.
Y = 255-B, M = 255-G, C = 255-R
About K Printing
K ink is used for crisp, high-quality printing of black text. The data for K ink is
Boolean (or 1 bit per pixel), where 0 stands for white or no printing, and 1 is black
and is printed.

SR200 & SR300 Printer SDK Guide
Page 9
About UV Ink
UV ink becomes visible with ultraviolet rays. UV data is grayscale data, in the range
of 0 to 255. 255 provides the maximum coverage.
UV and YMCK inks cannot be transferred in the same area on the same retransfer
panel. Two retransfer panels must be used to print the UV ink on top of the YMCK
ink.
A single retransfer panel can be used to print UV and YMCK ink only if the area the
UV ink will be printed on is not first printed with YMCK. An area of 2 pixels (1) is
required between the K (2) and UV (3) printing. Be especially careful to maintain an
unprinted border or 2 pixels of more between K printing and UV areas if using one
panel.
When you use UV ink, the MAC address of the printer is always printed on the card
using the UV Panel. For best results reading the MAC address, do not print YMCK
on the MAC address block.
The location choices for printing the MAC address are Upper Right (1 in the
illustration) and Lower Left (2), where 3 is the 0,0 point of the card image. The MAC
Address block is 34 pixels high and 230 pixels long. The text is centered in these
areas and is 18 pixels high and 200 pixels long.
The card orientation—landscape (A in the illustration) or portrait (B)—affects where
the MAC address block appears in the card design.
♦ Landscape: The upper right location starts at 764,18. The lower left location
starts at 42,611.
B
A

SR200 & SR300 Printer SDK Guide
Page 10
Landscape style: Image is sent
with landscape pixel order.
The dashed lines mean the application
must change the pixel order. The pixel at
the top of left corner must be sent first, and
the pixel at the bottom of right corner must
be sent last.
♦ Portrait: The upper right location starts at 612,743. The lower left location
starts at 19, 42.
About the Pixel Order for Images Sent to the Printer
Pixels must be sent to printer in Landscape order. If an image has portrait
orientation, the application must change the pixel order to landscape when sending
the data using the ImageOut function.
Portrait style: Image is sent with
portrait pixel order.
(Actual printed Image on the card)
The solid line means the order of the pixels
in a line to send to the printer.
About the Peel Off Panel of the Ink Ribbon
The Peel Off panel of the YMCKPO Ink ribbon provides the ability to prevent
printing on a magnetic stripe, signature panel, or other area on the card. Using
driver settings for Special Ink 2 blocks printing and uses the peel-off panel to lift
retransfer film. When using the API to print, you must perform print blocking and
specify the peel-off area. The energy range for Peel Off is from 0 to 255, with a
default of 230; a higher value has more power to peel off, but increases the
possibility that the ink ribbon can fuse to the retransfer material.
The printer supports one peel-off area at the trailing edge of the card. If you need
additional areas, contact your service provider for more information.
The quality of Peel Off depends on the shape, size and location of the peeled off
area. In addition, the operating environment of the printer influences the quality of
Peel Off. Use Peel Off after you confirm that Peel Off works well in your card
design. Contact your dealer to learn more about Peel-off ribbon.

SR200 & SR300 Printer SDK Guide
Page 11
Define LUT Function
No.
Function Name
Explanation
1
intCXCMD_DefineLUT
(int iSlot,int iID,
int iColor,
intiLength,
BYTE *pbyBuffer)
Change the look up table in the printer.
iColor Each color has its own look up table. Possible
values are 2 for C, 4 for M, 6 for Y. (0 for K is reserved
for printer use.)
iLength The length of LUT data in bytes.
From 0 to 256.
pbyBuffer LUT Data.
About Look Up Tables (LUT)
A look up table is a method of adjusting RBG color values. The value X in the
image data is replaced with LUT[X] value when it is printed.
LUT data is 256 bytes in length, and transforms the color being printed. Look up
table data in the printer is set to the default value whenever the printer is powered
on.
The printer has 4 look up tables, one for each color transformation. The following
table shows how LUT data transforms output.
→→
→→
→→
: : : :
→→
→→
→→
ImageData
from Host
0
1
2
BytePosition
in LUT
Valueof
LUT
0
0
1
2
2
5
: :
253
255
254
255
255
255
Color actually
printed
0
2
5
253
254
255
255
255
255

SR200 & SR300 Printer SDK Guide
Page 12
Print Function
No.
Function Name
Explanation
1
int CXCMD_Print
(int iSlot,int iID,
int iColor,
int iBuffer,
int iImmed)
Print on Retransfer film.
iColor Specify the color to print.
Bit 0:YMC
Bit 1: K
Bit2:UV
Bit 3:PO
Bit 4-5: The location of the MAC address printed with UV.
1 Upper Right Corner
2 Lower Left Corner
iBuffer Image Data buffer number. The printer has two image
buffers for all images. Specify:
0 to use Buffer 0.
1 to use Buffer 1.
iImmed The immediate flag specifies when the printer replies.
0 Reply after printer finishes printing.
1 Reply immediately after printer accepts the command.
2
Int
CXCMD_SecurityPrint
(intiSlot,intiID,
Int iColor,
intiBuffer,
int iImmed)
Print the Security Erase feature, which conceals the text on
the K panel and the retransfer film by printing again from the
K panel to the retransfer panel.
iColor Specify the color to print. Only K is allowed.
Bit 0:YMC (not supported)
Bit 1: K
Bit 2: UV (not supported)
Bit 3:PO (not supported)
iBuffer Image Data buffer number. The printer has two image
buffers for all images. Specify:
0 to use Buffer 0.
1 to use Buffer 1.
iImmed The immediate flag specifies when the printer replies.
0 Reply after printer finishes printing.
1 Reply immediately after printer accepts the command.
Tips for Success
♦ The peel-off panel prevents applying the retransfer film onto the card, used in
areas such as the magnetic stripe. If using the Peel-off panel, block printing in
the area where peel-off will be used.
♦ Print Security Erase after the YMCK image is printed on the retransfer film and
after it has been transferred to the card by the heat roller. The security erase
image is not transferred. This function is only available when using YMCK,
YMCK-UV and YMCK-K ink.

SR200 & SR300 Printer SDK Guide
Page 13
Functions for Moving and Discharging the Card
The API provides the following functions to move and discharge the card:
♦ Card Load Function
♦ Card Move Function
Card Load Function
No.
Function Name
Explanation
1
intCXCMD_LoadCard
(int iSlot, int iID,
intiDest,
int iFlip,
intiFilmInit,
int iImmed)
Pick a card and move it to the specified position.
iDest Destination to move card.
0 Retransfer position
1 Contact IC encoder
2 No-contact IC encoder
3 MG encoder
4 NG Card outlet. Discharges the card from NG card
outlet (on the right side of the printer).
iFlip Specify whether turn over the card.
0 Do not turn the card over
1 Turn over the card before arriving at the destination
iFilmInit Specify whether to move the retransfer film. This
setting is effective only when iDest is 4 (NG Card outlet).
0 Not adjusted
1 Adjusted
iImmed The immediate flag specifies when the printer
replies.
0 Reply after printer finishes printing.
1 Reply immediately after printer accepts the command.
Tips for success
♦ If the retransfer film is printed on but not used, set iFilmInit to 1 to move the
printed area of the retransfer film.
♦ The printer returns an error if CXCMD_LoadCard() is used when there is a
card in the printer.
♦ The printer returns a positive value if CXCMD_LoadCard() is issued while the
printer is moving a card or the retransfer film. See Return Codes from
Functions for return values.
♦ If the function returns a positive value, wait and retry the function.

SR200 & SR300 Printer SDK Guide
Page 14
Card Move Function
No.
Function Name
Explanation
1
intCXCMD_MoveCard
(int iSlot, int iID,
intiDest,
int iFlip,
intiFilmInit,
int iImmed)
Move a card (after it is picked) to the specified position.
iDest Destination to move card.
0 Retransfer position
1 Contact IC encoder
2 No-contact IC encoder
3 MG encoder
4 NG Card outlet. Discharges the card from NG card
outlet (on the right side of the printer).
iFlip Specify whether turn over the card.
0 Do not turn the card over
1 Turn over the card before arriving at the destination
iFilmInit Specify whether to move the retransfer film. This
setting is effective only when iDest is 4 (NG Card outlet).
0 Not adjusted
1 Adjusted
iImmed The immediate flag specifies when the printer
replies.
0 Reply after printer finishes printing.
1 Reply immediately after printer accepts the command.
Tips for success
♦ If the retransfer film is printed on but not used, set iFilmInit to 1 to move the
printed area of the retransfer film.
♦ The driver returns an error if CXCMD_LoadCard() is used when there is no
card in the printer.
♦ The driver returns a positive value if CXCMD_LoadCard() is issued while the
printer is moving a card or the retransfer film. See Return Codes from
Functions for return values.
♦ If the function returns a positive value, wait and retry the function.

SR200 & SR300 Printer SDK Guide
Page 15
Retransfer to Card Functions
RetransferFunctions
No.
Function Name
Explanation
1
int
CXCMD_RetransferAndEject
(int iSlot,int iID,
int iImmed)
Retransfers the image from the film to the card, and
then moves the card out through the card discharge slot
(on the left side of the printer).
iImmed The immediate flag specifies when the printer
replies.
0 Reply after printer finishes printing.
1 Reply immediately after printer accepts the
command.
2
int
CXCMD_RetransferAndTurn
(intiSlot, int iID,
int iImmed)
Retransfers the image from the film to the card, turns
the card over, and then moves the card to the retransfer
position.
iImmed The immediate flag specifies when the printer
replies.
0 Reply after printer finishes printing.
1 Reply immediately after printer accepts the
command.
3
CXCMD_Retransfer
(int iSlot, int iID,
int iImmed)
Retransfers the image from the film to the card, and
then moves the card to the retransfer position (for
transferring the UV image to the card).
iImmed The immediate flag specifies when the printer
replies.
0 Reply after printer finishes printing.
1 Reply immediately after printer accepts the
command.
Tips for success
♦ The driver returns an error if CXCMD_RetransferAndEject() or
CXCMD_RetransferAndTurn() are used when the card is not in the retransfer
position.
♦ The driver returns a positive value if CXCMD_RetransferAndEject() or
CXCMD_RetransferAndTurn() are issued while the printer is moving a card or
the retransfer film. See Return Codes from Functions for return values.
♦ If the function returns a positive value, wait and retry the function.