Migrating from ScanTools II Link SDK Programs

Changes were made to the following methods. Default values were removed, parameters that were optional are now required:

• ScanningManager.FindAndConfigureScannerAsync
• ScanningManager.GetPortsWithScanners method
• ScanningManager.Scan
• ScanningManager.Diagnose
• ScanningManager.Stop

Additionally, scanner configuration information of the currently active scanner is no longer stored in the registry. The configuration information received from ScanningManager.AutoConfigureScanner and ScanningManager.ConfigureScanner is not saved anywhere. Each time ScanningManager is instantiated, this information in not available. The solution program should save the scanner configuration to an application specific location. The location can be a file, database or registry entry. This information must then be provided when ScanningManager is instantiated. You must create an instance of HardwareConfig, populate it using the previously saved configuration information, and call ScanningManager.ConfigureScanner with this instance of HardwareConfig. For more details see Set Up the Scanner.

Changes were made to the following properties. You MUST specify a directory for the following:

• SessionInfo.ApplicationDirectory
• SessionInfo.ProfileDirectory
• SessionInfo.DataDirectory

Changes were made to the following method. Default values were removed, parameters that were optional are now required:

• OmrBuffer.Display method

ScanTools Plus Link SDK uses an entirely new set of events. The events in ScanTools II Link SDK are deprecated. We strongly advise you revise your program to use the new events. For details on the new events see: ScanningManagerEvents Summary

This list is a quick reference for what new event replaces the old event. All new events use ScanEventArgs.

ScanTools II Link Deprecated Events	ScanTools Plus Link Events
OnSheetAtPrintHead Used ISheetOutput	XPrint Use ScanEventArgs.Document and Sheet
OnDocComplete Used IDocOutput	DocComplete Use ScanEventArgs.Document and Sheet
OnScanError Used IScanErrors	ScanError Use ScanEventArgs.Errors
OnGeneralError Used IGeneralError	ServerMessageBox Use ScanEventArgs.ServerMessage
OnScannerButtonPressed Used long for button type	ScannerButtonPressed Use ScanEventArgs.ScannerButtonPressed
OnDiagDataAvailable Used IOmrBuffer	DiagDataAvailable Use ScanEventArgs.OmrHelper
OnSessionComplete	SessionComplete

A new feature, Image Header Fields, was added to the ScanTools Plus application definition for image clipping. This must be enabled for any ScanTools Plus application that will use image clipping with ScanTools Plus Link. You must open the ScanTools Plus application, enable Image Header fileds, and save the application. If the application has profiles, the profiles must be recreated. For details see: Image Header Fields - ScanTools Plus Application Definition.

The Scantron OLE DB provider for ScanTools Plus Link represents date fields as instances of type DBTYPE_DBDATE, while with ScanTools II Link, the provider used DBTYPE_STR. The result is with ScanTools Plus Link, if the date field is not valid (blank, contains omits or multiples, or not a legal date), the value is returned as NULL. Solution programs must check for the presence of NULL before attempting to use the data. Alternatively, instead of querying for data from the table [Document Name], data can be requested from [Simple View of Document Name], which represents all data as instances of type DBTYPE_STR. See also: Date Fields

If you are performing synchronous scanning, you may need to change your scanning routine due to minor differences in behavior between ScanTools II Link SDK and ScanTools Plus Link SDK:

Previously, your initial call to Scan() caused the sheet to move to the print station. When the call completed, the SheetOutput object was available. The first call to BlockForScannerEvent did nothing.

In ScanTools Plus Link SDK, your initial call to Scan() does nothing visible (Ping() returns L_STATE_SCANNING). The first call to BlockForScannerEvent causes the sheet to move to the print station and the SheetOutput object becomes available.

Sample programs are installed with the ScanTools Plus Link SDK software that demonstrate how to migrate from ScanTools II Link to ScanTools Plus Link, using the new events. They are installed under [install drive]:Program Files\Scantron\ScanTools Link Plus SDK\Samples:

• Visual Basic 6.0\Visual Basic 6.0 Scanning
• Visual C++ \Visual C++ 6.0 Scanning

Comments are included in the sample code files, search for the term "Migration" in the files.

For details about the sample programs, see Scanning Sample - Visual Studio 6.0