This event is fired when the operator control dialog is about to be shown. See the ScanBeforeSaveDlg and ScanAfterSaveDlg events.
Note that the Job object is available even though this event is fired on application level in Scan.
This event is similar to ScanOutOfPaper, though this event is fired in more error situations. If possible, use this event instead of the old ScanOutOfPaper.
If you do not want to see the normal operator control dialog (the one that displays "The automatic document feeder is empty" or other message), return EV_OK_ABORT and set the return value using SetReturnValue.
If you want to stop scanning, use the SetReturnValue (0, "Stop") method. This is the default return value.
If you want to continue scanning, use SetReturnValue (0, "Cont").
If you want to start a new batch, use SetReturnValue (0, "New").
If you want to delete the current batch, use SetReturnValue (0, "Delete").
If you want to rescan, use SetReturnValue (0, "Rescan").
| Warning |
|---|
|
Use only return values that correspond to buttons that are enabled in the normal dialog in the current situation. See ErrorSituation parameter below. For example, is it not advisable to set the return value to "Cont" when ErrorSituation is 2 (the batch is complete), because the button is not enabled in that situation in the normal operator dialog. Setting inappropriate return values can lead to strange behavior and errors. |
The ErrorInfo parameter string is similar to the one that is shown in the standard operator control dialog, typically "The automatic document feeder is empty."
The ErrorSituation parameter can have one of these values:
|
Value |
Description |
|
1 |
No more paper in the automatic document feeder. |
|
2 |
The batch is complete. |
|
3 |
The document cannot be identified. |
|
4 |
Confirm batch and stop process. |
|
5 |
Unable to determine if set break should be made. The scanned document may indicate a new set that violates the set rules or contains an uninterpretable break field. |
|
6 |
Incorrect number of appendices present. |
|
7 |
LASTSTAMP (Confirm batch and stop process). |
|
8 |
Flatbed scanning is on. |
|
4000 |
Scanner error. See the GetErrorMsg method on the Application object for more information. |
|
4004 |
Kofax Scanner error. See the GetErrorMsg method on the Application object for more information. |
|
4001 |
Document error. See the GetErrorMsg method on the Application object for more information. |
|
Return value |
Description |
|
EV_OK |
Normal return. |
|
EV_OK_ABORT |
Do not show the normal operator control dialog. |
|
EV_ERROR |
Causes an error message and job termination. |
Could be used to skip the normal operator dialog in certain situations or to update your endorser string.
Only fired in the Scan module. If you return EV_OK_ABORT in ScanOutOfPaper, this event is not fired.
See also ScanUserNotified.