|
Products | Support | Email a link to this topic. | Send comments on this topic. | Back to Introduction - All Topics | Help Version 19.0.4.3
|
| Leadtools.Documents.Converters Namespace : DocumentConverterJobError Structure |
[DataContractAttribute()] [SerializableAttribute()] public struct DocumentConverterJobError : System.ValueType
'Declaration
<DataContractAttribute()> <SerializableAttribute()> Public Structure DocumentConverterJobError Inherits System.ValueType
'Usage
Dim instance As DocumentConverterJobError
public class DocumentConverterJobError
[DataContractAttribute()] [SerializableAttribute()] public value class DocumentConverterJobError : public System.ValueType
When the value of DocumentConverterOptions.JobErrorMode is DocumentConverterJobErrorMode.Abort, any error that may occur while running a job will result in an exception being thrown.
If the value of this property is DocumentConverterJobErrorMode.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 with 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 DocumentConverterJob.Errors collection. When conversion 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 value in DocumentConverterJob.Errors contain the following information:
| Member | Description |
|---|---|
| InputDocumentPageNumber |
The 1-based number of the page in the input document that caused the error. This value may be 0 if the error that occur is not specific for any page. |
| Operation |
The operation that was running when the error occured. |
| Error |
The exception that was thrown (if any). May be null. |
For an example, refer to RunJob and RunJobAsync.