Using Scanapi; Sdk Initialization/De-Initialization; Device Control; Scanner Data Access - Socket SocketScan SDK User Manual

3.0 U S API
SING CAN
The ScanAPI SDK offers API calls that are grouped into the following categories:
The ScanAPI.DLL file is written in C++. This file can only be used in development environments that can
directly call Win32 DLLs and process Windows messages. At this time, there is no support for Java.
3.1 SDK I
NITIALIZATION
•
ScanInit() initializes the ScanAPI DLL and allows the client to register for device insertion and
removal messages
•
ScanEnableMultiScanner() enables multiple scanners
•
ScanDeinit() closes any open scanning devices and performs clean-up in the DLL pending
shutdown
3.2 D C
EVICE ONTROL
•
ScanOpenDevice() opens a scanning device for use
•
ScanCloseDevice() closes a scanning device
•
ScanGetDevInfo() returns a structure giving device identification and capabilities
•
ScanSetGoodReadSound() allows the selection of a sound to be made when the user scans
data
•
ScanGetStatus() returns current status of the scanner
•
ScanParamSend() modifies a parameter of the scanner (CFSC/SDSC/CHS only)
•
ScanParamRequest() retrieves a parameter of the scanner (CFSC/SDSC/CHS only)
•
ScanParamSendEx() modifies a 2 byte parameter of the scanner (CFSC/SDSC/CHS only)
•
ScanParamRequestEx() retrieves a 2 byte parameter of the scanner (CFSC/SDSC/CHS only)
•
ScanSendCommand() sends a command to the CF Scan Card 5X (CF Scan Card 5X only)
•
ScanCommandFeature() sends a specific command to use a scanner feature
3.3 S D
CANNER ATA
•
ScanRequestDataEvents() allows the client to register for scanned data notifications
•
ScanTrigger() initiates a scan (soft-trigger) usually for a scanner with no hardware trigger
(CFSC/SDSC) or a Select Tag for the RFID reader and also works with the CHS/CRS
•
ScanAbort() aborts a scan on a TAG read if one is in progress
•
ScanGetScannerRegKey() returns the scanner's active key or driver key
•
ScanGetData() retrieves scanned data
3.4 M
ISCELLANEOUS
•
ScanErrToText() can be used to translate ScanAPI error codes to human-readable text
•
IsScannerConntected() checks whether the scanner is connected and open for
communications
April 8, 2010
Document#: 6410-00147 K
/D -
E INITIALIZATION
A
CCESS
U
TILITY
Page 11
Revision 2.28