1.0
I
NTRODUCTION
Note: In this document, the word “scanner” refers to any Socket data collection device, and the
word “scan” refers to a bar code scan, RFID read or magnetic stripe read, unless otherwise noted.
The Socket ScanAPI is a set of Windows CE and Win32 Desktop DLLs that offer access to the complete line of
data collection products from Socket:
•
Secure Digital Scan Card Series 3
•
CompactFlash Mag Stripe Reader Card Series 4
•
CompactFlash Scan Card Series 5
•
CompactFlash RFID Reader Card Series 6
•
Socket
Bluetooth
® Cordless Hand Scanner Series 7
•
Socket
Bluetooth
® Cordless Ring Scanner Series 9
By using the ScanAPI, applications can easily perform the following functions:
•
Receive notification of the insertion or removal of a plug-in data collection device or the connection or
disconnection of a wireless data collection device
•
Determine the type and properties of data collection devices inserted
•
Trigger (and abort) scanning/reading on supported devices that do not have a hardware trigger
•
Receive notification of data available from the scanner/reader
•
Configure end-user good-read acknowledgement using a beep or by playing a .wav file
Since ScanAPI returns the data block read from the scanner/reader, it is a simple matter for applications to
pre-process the data before its final disposition. Applications may add a prefix or a suffix to the data, and
perform any other application-specific character translations, insertions or deletions, if desired.
A version of the Socket keyboard wedge software, “SocketScan,” is based on the ScanAPI. It is included in
versions for each supported platform on the SDK CD and may also be downloaded from the Socket web site
at
www.socketmobile.com
. Its features include:
•
Recognition of the entire line of Socket data collection products
•
Flexible addition of prefix and/or suffix to the scanned/read data
•
Configuration of a good-read acknowledgement sound
•
A “silent mode” allowing VARs to run the wedge software in the background, making it invisible to the
user (for Windows CE only)
•
Registry entries allowing VARs to configure the prefix, suffix, sounds, and other properties at install-time
using their own custom installer
•
A “Preview DLL” can be registered with the wedge, allowing developers to preview and modify data
scanned by the user
All binary files for the SocketScan program may be freely distributed by the Developer, for use with Socket
data collection products. The documentation supplied is protected via copyrights held by their respective
owners and cannot be distributed without written permission.
© Socket Mobile, Inc.
October 2, 2008
Page 7
Document#: 6410-00147 J
Revision 2.24
