ScanningManagerEvents.ScanError event

This event is fired whenever ScanTools Plus software has detected a scanner error and is ready to display its Scanner Error dialog. A typical scenario is "hopper empty". Scanner error situations include paper jams, skew, and image quality. The display panel on a table-top scanner reports the specific scenario.

This event is the result of a Scan or Diagnose command.

What You Can Do

Basic Error Handling - Using L_CLIENTHANDLES_SCANERRORS_BASIC you can:

1. Display a custom error dialog.
2. Obtain a whole sheet image, provided there was no digitization error.
3. Advanced Error Handling - Using L_CLIENTHANDLES_SCANERRORS_ADVANCED you can do the above plus:
4. Specify the document number and/or litho-code for the first sheet of an unscannable document. Access to the Document and Sheet objects.
5. Deem a sheet as unscannable and tell ScanTools to ignore the error and continue processing – data will be key-entered at a later time.
6. Implement attachments by telling ScanTools to ignore the sheet

See Handle Scanner Errors for more information.

ScanningManager.Ping returns L_STATE_EVENTHANDLER_SCANERRORS at this event.

The ScanError event has the following behavior depending upon whether the error is ignorable or not ignorable and whether you are performing basic or advanced client scanner error handling. Click for details:

• The error is IGNORABLE

  When ScanEventArgs.Errors. CanIgnoreError=true	L_CLIENTHANDLES_ SCANERRORS_BASIC	L_CLIENTHANDLES_ SCANERRORS_ADVANCED
  State of transport	Cleared - For errors like multi-feed and jam, sheet(s) are left on the bed.	Potentially running - For errors like multi-feed and jam, sheet(s) are left on the bed.
  ScanEventArgs.Errors.RecoveryString	Valid	Invalid
  ScanEventArgs.SheetsNotProcessed	Valid	Invalid

• The error is NOT IGNORABLE

  When ScanEventArgs.Errors. CanIgnoreError=false	L_CLIENTHANDLES_ SCANERRORS_BASIC	L_CLIENTHANDLES_ SCANERRORS_ADVANCED
  State of transport	Cleared - For errors like multi-feed and jam, sheet(s) are left on the bed.	Cleared  - For errors like multi-feed and jam, sheet(s) are left on the bed.
  ScanEventArgs.Errors.RecoveryString	Valid	Valid
  ScanEventArgs.SheetsNotProcessed	Valid	Valid

IDL

HRESULT ScanError([in] IScanEventArgs* ScanEventArgs);

Input Parameters

IScanEventArgs with the valid properties as listed in ScanEventArgs and ScanningManager Events Valid Combinations.

Exceptions

Scanning Services Exceptions

See also

ScanEventArgs Interface Summary

ScanningManagerEvents Summary

How to Handle Scanner Errors

ScanningManager.SetKernelErrorMode method