Errors Property

Summary

Any errors occurred when this job is run.

Syntax

C++/CLI

Java

Python

public IList<DocumentConverterJobError> Errors { get; }

public:  
   property System::Collections::Generic::IList<Leadtools::Documents::Converters::DocumentConverterJobError^>^ Errors 
   { 
      System::Collections::Generic::IList<Leadtools::Documents::Converters::DocumentConverterJobError^>^ get() 
   }

public List<DocumentConverterJobError> getErrors()

Errors # get  (DocumentConverterJob)

Property Value

A list of DocumentConverterJobError objects that contain detailed information on any errors that may have occurred when this job is run.

Remarks

The Errors will contain detail information on what caused the job to fail (or partially succeed). The value of Status will be DocumentConverterJobStatus.Aborted or DocumentConverterJobStatus.SuccessWithErrors in this situation.

If the value of DocumentConverterOptions.JobErrorMode was DocumentConverterJobErrorMode.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 by OCR. 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 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.

Example

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Document.Writer; 
using Leadtools.Svg; 
using LeadtoolsExamples.Common; 
using Leadtools.Document; 
using Leadtools.Caching; 
using Leadtools.Annotations.Engine; 
using Leadtools.Ocr; 
using Leadtools.Document.Converter; 
using Leadtools.Annotations.Rendering; 
 
public void DocumentConverterJobsRunJobExample() 
{ 
   using (DocumentConverter documentConverter = new DocumentConverter()) 
   { 
      var inFile = Path.Combine(ImagesPath.Path, @"Leadtools.doc"); 
      var outFile = Path.Combine(ImagesPath.Path, @"output.tif"); 
      var format = RasterImageFormat.Tif; 
      var jobData = DocumentConverterJobs.CreateJobData(inFile, outFile, format); 
      jobData.JobName = "conversion job"; 
 
      var job = documentConverter.Jobs.CreateJob(jobData); 
      documentConverter.Jobs.RunJob(job); 
 
      if (job.Status == DocumentConverterJobStatus.Success) 
      { 
         Console.WriteLine("Success"); 
      } 
      else 
      { 
         Console.WriteLine("{0} Errors", job.Status); 
         foreach (var error in job.Errors) 
         { 
            Console.WriteLine("  {0} at {1}: {2}", error.Operation, error.InputDocumentPageNumber, error.Error.Message); 
         } 
      } 
   } 
}

Requirements

Target Platforms

Reference

DocumentConverterJob Class

DocumentConverterJob Members

Leadtools.Document.Converter Namespace

Using LEADTOOLS Document Converter

Download our FREE evaluation

Help Version 22.0.2023.5.10

Leadtools.Document.Converter Assembly

Introduction

Getting Started

Namespaces

Leadtools.Document.Converter Namespace

Assemblies