ScanEventArgs.SheetsNotProcessed property

Read-only property.

This property is meaningful only at the SessionComplete and ScanError events. A value of -1 indicates that it is not valid within the current context.

At the SessionComplete event

It is the count of sheets that were unprocessed but flushed just prior to the end of the scanning session. The scanning session ends:

• When the operator clicks the End Scanning button on the scanning progress window.
• When the operator clicks the Stop button when the scanner error dialog is displayed.
• In response to a call to the ScanningManager.Stop method invoked by the solution program.

These sheets were not processed by ScanTools Plus and they typically end up in the select stacker.

NOTE: In the case of scanners like the iNSIGHT 30, there is only one output hopper.

A typical application of this property is to log this number to a file for audit purposes or to prompt the operator to rescan the sheets in a subsequent batch.

At the ScanError event

There are two scenarios, depending on whether or not the error can be ignored by the solution program:

• When ScanEventArgs.Errors.CanIgnoreError = false, it is the count of sheets that were not processed but flushed just prior to the error on the last processed sheet.  ScanEventArgs.Errors.RecoveryString is valid. The solution displays a modeless dialog with the buttons Resume, Rescan, and Stop.
• When ScanEventArgs.Errors.CanIgnoreError = true, ScanEventArgs.SheetsNotProcessed and ScanEventArgs.Errors.RecoveryString are undefined. You should call SetScanErrorResolution L_CLEAR_TRANSPORT_AND_UPDATE_ERRORS) to make this valid.

Valid

See ScanEventArgs and ScanningManager Events Valid Combinations and Events and Valid Properties/Methods.

IDL

[propget] SheetsNotProcessed([out, retval] LONG*pVal);

Values

Less than 1 means that no sheets remain unprocessed.

Greater than one means that there are sheets that are not processed. Inform user of unprocessed sheets.

Exceptions

Scanning Services Exceptions Overview

See Also

ScanningManagerEvents Summary