ScanWait

Description

Starts a scan operation that returns only after the scan data has been read or the scan timeout period has expired.

Applies to

BarcodeScanner objects

Syntax

Integer scanner.ScanWait (timeout )

Argument	Description
scanner	The scanner object for which you want to perform the scan
timeout	Integer value for the time period in seconds after which scan data is returned

Returns

Integer. Returns 1 for success or one of the following negative values if an error occurs:

-1 Unspecified error
-2 Supporting DLL not loaded error
-3 Initialization error other than DLL not loaded
-4 Error in the passed in arguments
-5 Something in the object instance is inconsistent
-6 Call to the driver failed
-7 Error opening the specific scan device
-8 Error in the internal buffer allocation
-9 Incorrect scan state for the requested action (typically benign)
-10 Low level device error
-11 Read is already pending (typically benign)
-12 Read is cancelled (typically benign)
-13 Timeout period expired on the read (typically benign)
-100 Feature not implemented

Usage

For a synchronous scan operation, the scanner object returns data either immediately upon expiration of the timeout period set in the ScanWait call, or when a new scan is started.

Socket bar code scanner ScanWait is not supported by the Socket bar code scanner.

Examples

Example 1

The following example starts a scan and reads the data:

li_rtn = l_scanner.ScanWait(30)

li_rtn = l_scanner.RetrieveData( )

ls_value = l_scanner.ScannedData