JobDocumentRetrieve (ByRef DocPath1 As String, ByRef DocPath2 As String, ByRef DstPath1 As String, ByRef DstPath2 As String, ByRef Type As Integer, ByRef Result As Long) As Long

Description

This event is fired in Interpret when Data source extension is selected as the form source in the job description.

You provide FORMS with one or two files for interpretation. The files can be:

Image files. Supply two image files if the form is two-sided.
XML files. Supply only one XML file at a time.

The interpretation result is returned in the JobDocumentComplete event.

Optional: Use the DstDocPath1 and DstDocPath2 variables to specify where the files are to be placed after identification.

To see whether a form belongs to a set, check the job object for a set definition name. If the files you send to Interpret belong to sets, and the set definition includes logic, then you must send the files to Interpret in the correct order.

Use the Result parameter to control the further flow of the Interpret module. See below.

Parameters

Parameter	Description
DocPath1	The full path to the front page file.
DocPath2	The full path to the back page file.
DstDocPath1	The full path where the front page file is to be placed after identification. This string is represented by the #Importfile variable in the transaction description.
DstDocPath2	The full path where the back page file is to be placed after identification. This string is represented by the #Importfile2 variable in the transaction description.
Type	The type of document being processed: 0 normal form (with or without appendix) 1 set 2 batch
Result	Tells FORMS what to do next. 0 Process the supplied image file(s) in the DocPath1 and DocPath2 parameters. 1 Process the XML file in the DocPath1 parameter. -1 No more files to process. -5 If Wait for more forms is selected in the job description, use -5 to indicate that there are no more files for the moment. The last document is treated as the final document in a batch, set, or sequence of appendices. Then Interpret goes to wait mode. -6 If your data source extension has knowledge about the set or batch structure, and last document in as set or batch was returned in the last JobDocumentRetrieve event, use this value. The last Set, Batch, or Form is then saved. The job is not paused even if Wait for more forms is selected in the job description.

Return values

Return value	Description
EV_OK	Normal return.
EV_OK_ABORT	No effect— treated the same as EV_OK.
EV_ERROR	Causes an error message and job termination.

Suggested usage

Used by data source extensions, for example ReadSoft’s EMAIL or COLLECTOR program.

Remarks

Note that the data source extension is responsible for moving the files after identification.

Job-level events