You are here: Scanning User Exits > User Exit 98: ONERROR

User Exit 98: ONERROR

This only applies to scanning user exits, not for Edit or Score user exits.

You can use this user exit to:

Keep track of the scanning errors that have occurred using the scerrs member of the SLKDATA structure accessed as GetSlk()->scerrs. The values in this structure are defined in the scanerrs.h file.
This user exit point can also be used to skip an unscannable sheet by returning the IGNOREERROR request as puerec->request |= IGNOREERROR. If this user exit request is used to skip an unscannable sheet, the puerec->docnum value must be checked to see if the document that is being scanned has been identified yet. If the puerec->docnum is -1, the document being scanned has not yet been identified and the user must be queried to determine what document is being scanned. The 0-based number for the document being scanned must be set as the first byte in the image buffer, as puerec->imgbuf[0] = doc_number, before returning when an unscannable sheet is to be skipped. The puerec->docnum value passed to the user exit is 1-based but the returned value must be 0-based. The data for the grids defined on the unscannable sheet should be set to a value that will insure the field containing these grids will fail the edits defined for the field. This insures the field containing these grids can be entered (directly from the sheet itself) using the ScanTools Editor. ScanTools will automatically set the pass flag for the record for the unscannable sheet to FAILING to insure the record will be caught in the editor.

This user exit point can also be used to ignore a sheet that was scanned. The sheet is treated as if it had never been scanned by returning the IGNORESHEET request as puerec->request |= IGNORESHEET. If this value is returned, scanning will continue looking for the same sheet that was being looked for when the error occurred. This is different from the IGNOREERROR return which treats the sheet in error as if it were the correct sheet and then looks for the next sheet in the sequence defined in the application.

Parameter	Status
Exitpoint	98
Imgbuf	can or can not be valid depending on the scanning error which has occurred to cause the ONERROR user exit. The first byte of this buffer sends back the user input document number if the docnum value is -1 indicating scanning is still looking for a start of document.
Imgback	can or can not be valid depending on the scanning error which has occurred to cause the ONERROR user exit.
Outrec	Complete through the previous booklet page if scanning a booklet. can be complete through the current booklet page depending on the scanning error that has occurred to cause the ONERROR user exit.
Markbuf	Complete through the previous booklet page if scanning a booklet. can be complete through the current booklet page depending on the scanning error that has occurred to cause the ONERROR user exit.
Prtstr	Undefined
Reclen	can or can not be valid depending on the scanning error which has occurred to cause the ONERROR user exit and which sheet of a booklet is being scanned when the error occurs. Should be valid unless the docnum is set to -1 indicating the error occurred too early in the processing on the first sheet of a new document to determine which document is being scanned.
Appnum	Valid
Seqnum	Will always represent the expected sheet not the last sheet found, as is the case with other user exit points. This value can be used to find the grids to mark with edit failing characters, if the sheet is to be skipped.
Docnum	Will be -1 if the error occurred too early in the processing on the first sheet of a new document to determine which document is being scanned or will be valid. If the user exit is to skip the sheet in error, this value can be used to determine if the user exit must ask the user for the document being scanned. If this value is not -1, it can be used to find the grids to mark with edit failing characters, if the sheet is to be skipped. If it is -1, the user input document number must be used in setting the grids.
Request	0x80 IGNOREERROR 0x10000 IGNORESHEET
HwndScan	Valid

See Help on Help for additional information on using this help file.

See Scantron Technical Support for additional information on technical support and training options.

See the ScanTools Suite System Requirements for further details on hardware and software requirements.

ScanTools is a suite of products; the specific information you want may appear in the help for a different module. If you don't find what you're looking for here, try one of the following:

ScanTools Plus Scanning Module WebHelp

(includes Real-Time Character Recognition utilizing NestorReader Help)
ScanTools Plus Application Designer Module WebHelp

(includes Real-Time Character Recognition utilizing NestorReader Help)
ScanTools Plus Download Utility WebHelp
ScanTools Plus User Exits WebHelp
ScanTools Plus Legacy Reference Information WebHelp

(a previous version of ScanTools Plus Help that may help power users)
ScanTools Plus Link SDK WebHelp
(API Help for developers)

Scantron Corporation

Customer Service (forms, products, and services):

1-800-SCANTRON (722-6876)

www.scantron.com

Technical Support:

1-800-445-3141

[email protected]

Copyright © 1998-2012 Scantron Corporation. All rights reserved. Use permitted only under license. www.scantron.com. No part of the Help or user guides may be reproduced in any form, or by any means, without express permission from Scantron Corporation.

LINKS TO THIRD PARTY SITES

This help system may contain links to third party websites ("Linked Sites"). The Linked Sites are not under the control of Scantron and Scantron is not responsible for the content of any Linked Site, including without limitation any link contained in a Linked Site or any changes or modifications to a Linked Site. Scantron is not responsible for web casting or any other form of transmission received from any Linked Site. Scantron provides Users with the ability to link the Assessment System to the Linked Sites as a convenience to you, and the inclusion of any link does not imply endorsement by Scantron of the Linked Site or any association with its operators.