LEADTOOLS OCR (Leadtools.Forms.Ocr assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
OcrAutoRecognizeManagerJobError Structure
See Also  Members  
Leadtools.Forms.Ocr Namespace : OcrAutoRecognizeManagerJobError Structure



The OcrAutoRecognizeManagerJobError Structure is available as an add-on to the LEADTOOLS Document and Medical Imaging toolkits.

Contains information on an IOcrAutoRecognizeManager job error.

Object Model

OcrAutoRecognizeManagerJobError Structure

Syntax

Visual Basic (Declaration) 
Public Structure OcrAutoRecognizeManagerJobError 
   Inherits System.ValueType
Visual Basic (Usage)Copy Code
Dim instance As OcrAutoRecognizeManagerJobError
C# 
public struct OcrAutoRecognizeManagerJobError : System.ValueType 
C++/CLI 
public value class OcrAutoRecognizeManagerJobError : public System.ValueType 

Example

For an example, refer to IOcrAutoRecognizeManager.RunJob.

Remarks

When the value of IOcrAutoRecognizeManager.JobErrorMode is OcrAutoRecognizeManagerJobErrorMode.Abort, any error that may occur while running a job will result in an exception being thrown.

If the value of this property is OcrAutoRecognizeManagerJobErrorMode.Continue, 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 not throw an exception if an error occur, instead, all errors will be logged into the job's IOcrAutoRecognizeJob.Errors collection. When recognition finishes, you can check if this collection is not empty and get the information of the errors and act upon them according to your application logic.

Each error in IOcrAutoRecognizeJob.Errors contains the following information:

Member Description
OcrAutoRecognizeManagerJobError.ImagePageNumber

The 1-based page number of the page in the source image file that caused the error. This value may be 0 if the error that occur is not specific for any page, for example, when creating an IOcrDocument or when DocumentWriter.Convert is called.

OperationOcrAutoRecognizeManagerJobError.Operation

The operation that caused the error.

ExceptionOcrAutoRecognizeManagerJobError.Exception

The exception that was thrown (if any). May be a null reference (Nothing in Visual Basic).

Inheritance Hierarchy

System.Object
   System.ValueType
      Leadtools.Forms.Ocr.OcrAutoRecognizeManagerJobError

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also

OcrAutoRecognizeManagerJobError requires an OCR module license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features