ScanningManager.Pause method

Interrupts the scanning operation and returns immediately. Scanning can subsequently be continued or stopped. This allows the scanner operator or solution program to take action (possibly corrective) and then resume scanning, rescan the last document scanned (only for booklets when beyond the first sheet), or stop scanning.

Pause causes the scanner to stop scanning and be placed in a not ready state. For most events, sheets waiting on the transport bed are routed to the primary select stacker. If there is no stacker, the sheets go to the output hopper. The scanner displays "Program paused". On larger scanners like the 5000i, the input hopper goes back to its rest position.

When scanning on an iNSIGHT 2 or 4 scanner, if a Pause is issued at the Clip event or DocStacked event event, an extra sheet will be fed.

No data from the sheets affected by Pause is captured; therefore nothing is written to either the ScanTools data file or clip file for the sheet(s). One exception is if Pause is invoked at the DocStacked event. See Data and Clip Considerations, below.

If ScanTools Plus is performing scanner error handling, the standard ScanTools Scanner Error dialog box appears with an error description of "Program requested pause" "Scanner not ready". This dialog allows you to select which action to continue with: Resume scanning, Rescan Document (only for booklets when beyond the first sheet), Stop scanning.

If the solution program is performing scanner error handling (see SetKernelErrorMode L_CLIENTHANDLES_SCANERROR), the ScanError event is fired and a ScanError object in the ScanEventArgs.ScanErrors collection is populated as follows:

• Description = "Program requested pause"
• Category = L_ERRCAT_ENUML_PAUSE_SCANNING

The solution program can compare the Category field against L_PAUSE_SCANNING and display a more meaningful description. The message on the scanner panel, "Program paused", cannot be changed.

Valid

See Scanning Manager States and Valid Properties/Methods

See ScanningManager Events and Valid Properties/Methods

IDL

HRESULT Pause();

Event Considerations

Below is a list of events fired before and after the Scanner Error dialog is displayed or the ScanError event is fired, depending on when Pause is invoked.

Further events after the Clip event depend on the scanner operator’s response in the Scanner Error dialog, or the solution program’s response to the ScanError event.

• Resume or ReScan Document fires the FormIdentified event
• Stop fires the SessionComplete event

Sheet Destination Considerations

For the following events, Pause causes the current sheet to be sent to the primary select stacker. If the scanner is not equipped with one, the sheet is sent to the output hopper.

• FormIdentified
• Resolved
• PreScore
• XPrint

For the Clip event (image scanners only): The Clip event is fired within the context of the current sheet so that you can take clips. The current sheet has already been printed and stacked at this time. When scanning on an iNSIGHT 2 or 4 scanner, an extra sheet is fed and sent to the primary select stacker or output hopper if no select stacker is present. This means that Pause at Clip can span across two documents, or cause sheets for one document to be split between the output hopper and the primary select stacker.

For the DocStacked event: The DocStacked event is fired within the context of the current document. The current document has already been printed and stacked at this time. When scanning on an iNSIGHT 2 or 4 scanner, the first sheet of the next document is fed and sent to the primary select stacker or output hopper if no select stacker is present.

Data and Clip Considerations

For all events except DocStacked: No data is captured when Pause is used at these events. No data records are added to the data file, and no clips are added to the clip file.

For the DocStacked event: Data and clips for the current sheet has been captured. The output record for the current document is ready to be written to the data file, and clips for the current document are ready to be added to the clip file. If this is not what you want, use ScanEventArgs.RejectDocument property.

See also

Event Driven Scanning