←Select platform

DocumentConverterJobStatus Enumeration

Summary

Job status.

Syntax
C#
C++/CLI
Java
Python
[SerializableAttribute()] 
[DataContractAttribute()] 
public enum DocumentConverterJobStatus 
public [SerializableAttribute,  
   DataContractAttribute] 
   enum class DocumentConverterJobStatus sealed 
public enum DocumentConverterJobStatus 
class DocumentConverterJobStatus(Enum): 
   Success = 0 
   SuccessWithErrors = 1 
   Aborted = 2 
Members

0

Success

The job is successful.

1

SuccessWithErrors

The job is partially successful. Errors occurred

2

Aborted

The job was not successful and is aborted. Errors occurred

Remarks

DocumentConverterJobStatus is used as the type for these properties:

Property Description

DocumentConverterJob.Status

Final status of the conversion job

DocumentConverterJobEventArgs.Status

Current job status and to allow the user to abort the operation

Example
C#
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

Help Version 22.0.2023.5.10
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Document.Converter Assembly
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.