#include "ltocr.h"
L_LTOCR_API L_INT EXT_FUNCTION L_OcrAutoRecognizeManager_RunJob(autoRecognizeManager, autoRecognizeJob)
Runs a job.
Handle to the OCR engine auto recognize manager.
Handle to the OCR engine auto recognize job.
Value | Meaning |
---|---|
SUCCESS | The function was successful. |
< 1 | An error occurred. Refer to Return Codes. |
If you call this method from the same thread that created L_OcrAutoRecognizeManager, then the current thread will block till this method returns. To run a job asynchronously, use L_OcrAutoRecognizeManager_RunJobAsync.
When this method returns you can call L_OcrAutoRecognizeJob_GetErrors to get any errors that might occurred during the recognition process.
To use this method, initialize a new L_OcrAutoRecognizeJobData structure with the job's parameters (input image file name, pages, output document format, output document name, optional zones file name, etc.), then use L_OcrAutoRecognizeManager_CreateJob to create the L_OcrAutoRecognizeJob handle passed as job handle to this method. Finally, call L_OcrAutoRecognizeManager_RunJob passing the L_OcrAutoRecognizeJob handle.
This method will perform the following operations:
Loops through the pages specified in L_OcrAutoRecognizeJobData.FirstPageNumber and in L_OcrAutoRecognizeJobData.LastPageNumber in L_OcrAutoRecognizeJobData.ImageFileName and for each page:
1. The page is created using L_OcrPage_FromBitmap after we load the file into BITMAPHANDLE.
2. If L_OcrAutoRecognizeJobData.ZonesFileName contains a valid multipage zone file name and has an entry for the current page, then the zones are loaded with L_OcrPage_LoadZonesFile and applied to the page. If L_OcrAutoRecognizeJobData.ZonesFileName is a NULL or is empty string or it does not contain an equivalent page number, auto-decomposing of the page is performed instead with L_OcrPage_AutoZone.
3. L_OcrPage_Recognize is called to get the OCR data of the page.
4. The page is added to the internal OCR document using L_OcrDocument_AddPage.
When all pages are processed they will be saved to result file name specified in L_OcrAutoRecognizeJobData.DocumentFileName using the format specified L_OcrAutoRecognizeJobData.Format.
The L_OcrAutoRecognizeManager also has some options that you can control, For more information about these options, refer to L_OcrAutoRecognizeManager_GetOptions and L_OcrAutoRecognizeManager_SetOptions.
Required DLLs and Libraries
For an example, refer to L_OcrAutoRecognizeManager_SetJobOperationCallback