User Exit Parameters

When a user exit occurs, the parameters listed below are passed between ScanTools software and the user exit program in a UEREC structure. Each user exit parameter is described in the order in which it appears in the UEREC structure. The request parameter defines the actions to be performed at the user exit.

All parameters are used for the scanning user exits 1-99.

exitpoint (User Exit Number)

imgbuf (pointer to Sheet Image Buffer)

imgback (pointer to Backside Image Buffer)

outrec (pointer to Output Record Buffer)

markbuf (pointer to Mark Information Buffer)

prtstr (pointer to Transport Printer String)

reclen (Output Record Length)

appnum (ScanTools Application Number)

seqnum (Sheet Number)

docnum (Document Number)

request (Scanner Action Requests)

hwndScan (Window handle of the scanning progress window)

Only some of the parameters are used for the Edit User Exits; those used for editing are:

• outrec
• reclen
• appnum
• seqnum
• docnum
• hwndScan

NOTE: The structure for these parameters is declared in the file uexit.h.

You can use these parameters to modify buffers (such as outrec and prtstr) that are used by the scanner, editor, or scoring functions to communicate data and/or scanned information.

NOTE: Not all of these parameters are valid for every user exit. See the individual user exit description for information about which parameters are valid for that user exit. Also see: User Exits - Parameter Summary.