ScanningManager.AutoConfigureScanner method

Queries the scanner attached to the specified port, retrieves the hardware configuration settings from the scanner, and makes it the active scanner for the machine.

Upon successful execution:

• the scanner that was just auto-configured will become the active scanner.
• the state property of ActiveScanner is set to L_SCANNERSTATE_AUTOCONFIGURED.

• the port property of ActiveScanner reflects the port just configured.

NOTE: The AutoConfigureScanner method on an RS232 communications port sends out characters at various baud rates. This has the potential of causing odd behavior in non-scanner serial devices connected to serial ports on which auto configure is performed. Be sure to select the correct port before doing the auto-configure. See also: ScanningManager.GetPortsWithScanners method

You can then call ScanningManager.ActiveScanner .Scanner.GetScannerConfig method to obtain configuration details in an object of type HardwareConfig Object .

Using the port defined in the method, the following information is detected by AutoConfigureScanner.

• EZData scanner information detection

For the EZData scanner, the properties below are the only valid settings for HardwareConfig:

DisableSelectStacker = FALSE

BaudRate = L_BAUDRATE_9600

DataBits = L_DATABITS_7

Parity = L_PARITY_EVEN

StopBits = L_STOPBITS_1

Timeout = 10

• OpScan scanner information detection

For a few items on the OpScan scanner, the information detected is not accurate; you always have the option of using ScanningManager.ConfigureScanner method to force configuration parameters to the correct values.

• Baud Rate
• Data Bits
• Parity
• Stop Bits

For OpScan scanners, in the following cases the stop bits are not correctly detected, but this does not interfere with communications with the scanner:

• Any baud rate, 8 data bits, 1 stop bit (detected as 2), and Parity None
• Any baud rate, 7 data bits, 1 stop bit (detected as 2), and Parity None
• Any baud rate, 7 data bits, 1 stop bit (detected as 2), and Parity Even
• Any baud rate, 7 data bits, 1 stop bit (detected as 2), and Parity Odd

 

• Scanner Model
• Bar Code Reader
• Transport Printer

The OpScan 2/3/4/4U scanners do not report the presence of a printer. In the absence of any information from the scanner, AutoConfigureScanner assumes that one is present and sets the read-only property HardwareConfig.HasTransportPrinter to TRUE. You should use HardwareConfig.DisableTransport Printer when you do not have a printer installed.

• Select Stacker

The OpScan 3/4/4U scanners do not report the presence of a select stacker. In the absence of any information from the scanner, AutoConfigureScanner assumes that a select stacker is always present and sets the read-only property HardwareConfig.HasSelectStacker to TRUE. It is important to determine whether or not the scanner really has a select stacker, and configure the software accordingly.

If you do not have prior knowledge of the scanner, you must query the user to obtain this information. Update HardwareConfig.DisableSelectStacker property to TRUE if there is not a select stacker, otherwise to FALSE if it does. If needed, alter any other HardwareConfig properties, and then call ScanningManager.ConfigureScanner method with the modified HardwareConfig object to update the configuration in ScanTools Plus software.

Valid

See Scanning Manager States and Valid Properties/Methods

See ScanningManager Events and Valid Properties/Methods

IDL

HRESULT AutoConfigureScanner([in] L_PORT_ENUM Port, [in] BOOL ShowConfigDlgOnFailure);

Input Parameters

Port

Identifies the port with the scanner to be queried for auto-configuration. Port is of type L_PORT_ENUM. Make certain you select a port that actually has a scanner attached. See L_PORT_ENUM for all values.

Do not use L_PORT_USE_CURRENT for AutoConfigure.

ShowConfigDlgOnFailure

Identifies the action to take if a scanner is not detected on Port.

Exceptions

Scanning Services Exceptions

See also

How to Set Up the Scanner

How to Manage the Connection to ScanTools Plus Link Runtime