JobFormEndorseString(BatchNo As String, BatchIndex As String) As Long

Description

This event is only fired before a page is scanned, when Manual endorse is selected as an option in the Scan job description.

Parameters

Parameter

Description

BatchNo  

The batch number that the current page belongs to.

BatchIndex 

The batch index of the current page.

Return values

Return value

Description

EV_OK

The result is ignored, and the endorse string is as specified in the Scan job options dialog.

EV_OK_ABORT 

Normal return. The settings in Scan job options are ignored and the values produced by Job.SetEndorse methods are used instead.

EV_ERROR

Results in an error message.

Suggested usage

To compose a string that is imprinted on each scanned page, use the Job object and the methods concerning "Endorse" to define the endorse string and its location.

Remarks

Only fired in the Scan module.

SetEndorseFunction

SetEndorsePosition

SetEndorseString

Job-level events