ScanBatchDialogShow( BundleCnt As Long, BundleIndex As Long ) As Long

Description

If you do not want to see the normal Batching dialog, return EV_OK_ABORT and set the return value using SetReturnValue.

If you want to update batch variables in the Job object, use the SetReturnValue (0, "1") method. That is, if you want to change batch values for the ongoing scanning, change them via the BatchDef object (Job object for the classic API) and then use the SetReturnValue method. If you do not use SetReturnValue, no new values are used on the BatchDef object during scanning.

To change the start index, you must use the SetReturnValue (1, "NewStartIndex") method, where NewStartIndex is the index to start with. If you do not want to use a new start index, use SetReturnValue (1, "-1").

Note that the Job object and BatchDef object are available even though this event is fired on application level in Scan.

Parameters

The BundleCnt argument is the current batch number, and BundleIndex is the current batch index.

Return values

Return value	Description
EV_OK	Normal return. FORMS continues with normal batch scanning and shows the standard batch dialog.
EV_OK_ABORT	Do not show the normal Batching dialog.
EV_ERROR	Causes an error message and job termination.

Suggested usage

Can be used to show your own batch dialog instead of the standard FORMS dialog. See also the StartNo, Prefix, Size, ReportFileName, PrintReport, and Confirm properties on the BatchDef object.

Remarks

Only fired in the Scan module.