WIA Error Handler Tool
Note This content applies to the Windows Logo Kit (WLK). For the latest information using the new Windows Hardware Certification Kit (HCK), see Windows HCK User's Guide on the Windows Hardware Dev Center.
Type: Automated Test
Overview
This is an automated Windows Driver Kit (WDK) tool for testing behavior of WIA minidrivers related to error handler.
This tool verifies that a driver does not cause applications or the WIA service to crash or hang in edge conditions when the driver sends a message to an error handler or receives a message in its error handler. It also guarantees a consistent and quality experience for the user (Windows come and go when expected, and the driver handles messages from error handlers appropriately by canceling transfers, etc).
Details
This test runs either from the WDK or standalone from the command line. It logs results to the console and to a WTT log file, and can be configured to log at two different levels of verbosity. This test runs all test cases by default. However, individual test cases can be specified as well. The test requires the device ID of the WIA device that is being tested to be specified.
WIA 2.0 is a requirement for the test to pass in Windows 7 and Windows 2008 R2. WIA 2.0 is not a requirement for Windows Vista.
Run Time: 30 min
Log File:
System Restart Required: No
Test Category:
Supported operating systems for Logo or Signature testing:
Windows 7
Windows Server 2008
Windows Server 2008 R2
Windows Vista
Program:
Requirements
Software Requirements
The test tool runs on the following Windows operating systems:
- Supported operating system (see list above).
- Software components included with the device that is being tested.
Supported Software
Hardware Requirements
- Device to be tested
- Computer that meets the minimum software requirements
- If your device supports automatic document feeder, make sure there is enough paper in the feeder (usually about 50 pages).
Processor
- x86
- x64
Running WIA Error Handler Tool
Install WIA device to be tested.
Register WiaTestLog.dll using RegSvr32.
Run WiaErrorHandlerTool.
Note WIA tests may fail if you do not use the WIA Friendly name, To resolve this, please follow these steps:
Restart the DTM Client and wait for it to log in.
Close the Device Console.
Re-open the submission.
This will ensue that the gatherer data is in-sync and that the friendly name is populated.
If the steps above do not work, please work with your driver developer to make sure that the INF is referencing the driver correctly.
Command Syntax
| Command option | Description |
|---|---|
WiaErrorHandlerTool.exe |
|
[/help] |
Optional; List available command-line options. |
[/log:<logfilename>] |
Optional; Default is "ErrorHandler.wtl". |
[verboselog:<0 or 1>] |
Optional: Specifies whether to log with maximum verbosity. Default is "1". |
/device:<deviceID of device> |
Required: Four digit device ID of WIA device that is being tested. |
[/case:<case number>] |
Optional, for debugging purposes: Run only specified test case. Test will not log a pass unless all tests are run. |
Cautions
This tool performs error handler tests during data transfers. Therefore, data transfers must work correctly for this test to pass. Errors related to data transfer will be logged in the same format as by the Data Transfer WDK tool.
Troubleshooting
Use with command-line option /verboselog:1. Detailed logging goes into WTT log file.
Code Tour
File Manifest
| File | Location |
|---|---|
WiaErrorHandlerTool.exe |
%controller%\tests\<arch>\nttest\PrintScanTest\WIA\WiaErrorHandlerTool |
WiaTestLog.dll |
%controller%\tests\<arch>\nttest\PrintScanTest\WIA\WiaErrorHandlerTool |
Build date: 9/14/2012