L_OcrAutoRecognizeJob_GetErrors - OCR Module - LEAD Engine C++ API Help

L_OcrAutoRecognizeJob_GetErrors

#include "ltocr.h"

L_LTOCR_API L_INT EXT_FUNCTION L_OcrAutoRecognizeJob_GetErrors(autoRecognizeJob, value, count)

L_OcrAutoRecognizeJob autoRecognizeJob; handle to destroy
L_OcrAutoRecognizeManagerJobError** value; address to L_OcrAutoRecognizeManagerJobError* to be update with an array of job errors
L_UINT* count; number of items in 'value' which represents the number of errors occurred during the job

Gets an array that contains any errors occurred while job is running.

Parameter Description
autoRecognizeJob L_OcrAutoRecognizeJob handle to destroy.
value Address to L_OcrAutoRecognizeManagerJobError* to be update with an array of job errors. You must call L_OcrMemory_Free on this parameter to free its memory.
count Number of items in 'value' which represents the number of errors occurred during the job.

Returns

SUCCESS The function was successful.
<1 An error occurred. Refer to Return Codes.

Comments

If the value of L_OcrAutoRecognizeManagerOptions.JobErrorMode (you can get retrieve L_OcrAutoRecognizeManagerOptions by calling L_OcrAutoRecognizeManager_GetOptions) was L_OcrAutoRecognizeManagerJobErrorMode_Continue when this job is run, then none critical errors can be logged and running continues. For example, if a source document has a page that could not be recognized. The offending page will be added to the final document as a graphics images and recognition will continue to the next page. In this mode, the engine will abort the whole job if an error occur, instead, all errors will be logged into the job's internal errors list that you can retrieve by calling L_OcrAutoRecognizeJob_GetErrors. When recognition finishes, you can check if this list is not empty and get the information of the errors and act upon them according to your application logic.

Note: You must call L_OcrMemory_Free on 'value' parameter to free its memory.

Required DLLs and Libraries

LTOCR
For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Help Version 20.0.2018.6.21
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS OCR Module - LEAD Engine C API Help