L_OcrAutoRecognizeRunJobCallbackData

Summary

Contains data for the L_OcrAutoRecognizeRunJobCallback callback that occurs when job starts or complete.

Syntax

struct L_OcrAutoRecognizeRunJobCallbackData 
{ 
   L_UINT StructSize; 
   L_INT Status; 
   L_OcrAutoRecognizeJob Job; 
   L_BOOL IsCompleted; 
}; 
typedef struct L_OcrAutoRecognizeRunJobCallbackData L_OcrAutoRecognizeRunJobCallbackData; 

Members

StructSize

Structure size. It should be equal to sizeof(L_OcrAutoRecognizeRunJobCallbackData).

Status

Gets the status of the current job. this value will contains SUCCESS if everything is going fine or ERROR_USER_ABORT if the user aborted the job by calling L_OcrAutoRecognizeManager_AbortAllJobs.

Job

Gets the job that triggered this callback.

IsCompleted

L_BOOL that indicates whether the job just started or completed (L_TRUE means the job is completed and L_FALSE to indicate job start).

Comments

L_OcrAutoRecognizeManager fired the L_OcrAutoRecognizeRunJobCallback when job starts or complete passing this structure as an argument for this callback.

L_OcrAutoRecognizeRunJobCallbackData.IsCompleted is L_FALSE this indicates the job is about to start. You can use the L_OcrAutoRecognizeRunJobCallback to keep track of the number of jobs pending running. You can also examine L_OcrAutoRecognizeRunJobCallbackData.Job to get information on whether the job finished successfully and get error status if any. L_OcrAutoRecognizeManager_RunJob example shows complete source code of how to easily accomplish these tasks in your application.

L_OcrAutoRecognizeRunJobCallback will get fired with L_OcrAutoRecognizeRunJobCallbackData.IsCompleted set to L_TRUE when the current job is aborted or completed.

To abort pending jobs in a multi-threaded application using L_OcrAutoRecognizeManager by calling L_OcrAutoRecognizeManager_AbortAllJobs.

L_OcrAutoRecognizeManager allows you to modify the bitmap handle, OCR page or OCR document during some parts of the operation. Refer to L_OcrAutoRecognizeJobOperationCallbackData.PageBitmap for more information.