ScanningManager.FindAndConfigureScanner method

This method attempts to search for a scanner regardless of whether or not a scanner is already configured. This method first looks for image scanners, then proceeds to look for serial scanners.

The method fires the ScannerSearch and ScannerFound events during this process.  This method blocks during the search process. Several seconds may elapse between the ScannerSearch and ScannerFound events – your solution program’s user interface may be unresponsive during this time – you should set expectations by displaying a suitable “Please wait..” style message at the ScannerSearch event. If a scanner was not found or the program skipped every scanner found or canceled the search process, the ScanTools Plus scanner configuration screen appears provided the parameter ShowConfigDlgOnFailure is set to true. Note that when the user configures a scanner and clicks OK on the scanner configuration dialog, no ScannerFound event results. This situation is equivalent to calling the ScanningManager.ConfigureScanner method.

Example Usage: Assume that ScanEng is an instance of the ScanningManager class

FoundAScanner= ScanEng.ActiveScanner.State <> L_SCANNER_STATE_NORESPONSE

if (not FoundAScanner) then

  FoundAScanner=ScanEng.FindAndConfigureScanner(true)

end if

if (FoundAScanner) then

  ScanEng.Scan mySes, L_PORT_USE_CURRENT  

end if

Valid

See Scanning Manager States and Valid Properties/Methods

See ScanningManager Events and Valid Properties/Methods

IDL

HRESULT FindAndConfigureScanner(([in] VARIANT_BOOL ShowConfigDlgOnFailure

[out,retval] VARIANT_BOOL* pResult

)

Input Parameters

ShowConfigDlgOnFailure

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

Return Value

Exceptions

Scanning Services Exceptions

See also

HardwareConfig Object Summary

How to Set Up the Scanner

How to Manage the Connection to ScanTools Plus Link Runtime