Compsee Apex III, Technical Reference Manual

Page: 86 / 168

Apex PDT Technical Reference Manual 6 Utility Programs
COAM30002 Rev. 2.00 8/13/02
6-14
Scan Control
BcApiScan
Syntax:
int BcApiScan(unsigned char id)
Input:
id = driver’s multiplex ID, usually BCD_ID (0CEh)
Returns:
0 for success, non-zero on failure.
Notes:
BcApiScan causes the scan engine to activate and the
scanning process to begin. For applications requiring fine
control when scanning is permitted, the application should
disable the driver from automatically activating when the
<SCAN> key is pressed (use “-BTN”), then monitor the
keyboard for the <SCAN> key and invoke this function
when scanning is desired.
The driver stops scanning when either the <SCAN> key is
released, the programmed timeout limits are exceeded, or
upon successful symbol recognition.
Register Buffer
BcApiRegisterBuffer
Syntax:
int BcApiRegisterBuffer (byte id, char far *buf, unsigned
size, unsigned far *decodedCount, CODETYPE far
*symbology)
Input:
id = driver’s multiplex ID, usually BCD_ID (0CEh)
buf = far pointer to a char buffer (array) for storing the
decoded symbol. This should normally be a static or
global array so that the array never goes out of scope. If
this pointer is NULL, wedge operation is assumed.
size = the size of the buf array in bytes (size_t characters)
decodedCount = far pointer to an unsigned int where the
count of decoded characters (not including the NULL
terminator) is stored by the driver. This should normally
be a static or global array so that the array never goes out
of scope. This parameter should not be NULL if buf is not
NULL.
symbology = far pointer to a CODETYPE variable. An
enumerated value is placed in this location by the driver
indicating the type of decoded symbology, i.e. Code 11,
Code 93, etc. See Table 6-3 for additional details.