←Select platform

LoadStatus Property

Summary

Gets a value that allows detection of whether the image was loaded with errors.

Syntax
C#
VB
Java
Objective-C
C++
public RasterExceptionCode LoadStatus { get; } 
Public ReadOnly Property LoadStatus As RasterExceptionCode 
@property (nonatomic, assign, readonly) LTError loadStatus 
public RasterExceptionCode getLoadStatus() 
public: 
property RasterExceptionCode LoadStatus { 
   RasterExceptionCode get(); 
} 

Property Value

A RasterExceptionCode which indicates the result of the most recent load operation.

The most common return values are:

Value Meaning
RasterExceptionCode.Success The image loaded by the last load call does not have any errors.
RasterExceptionCode.CompressedDataFailure There were errors decoding the last image. The bottom part of the image might be corrupted.
RasterExceptionCode.BadResyncMarker Some of the resync markers were incorrect or missing while decoding the last image. Resync markers are used by JPEG files to recover from decoding errors. Portions of the image are corrupted. They are indicated by a checkerboard pattern.
RasterExceptionCode.FileRead The file was truncated. The bottom part of the image is missing.

Remarks

An error return code is a warning that portions of the image that was last loaded might be corrupted.

This property should be called after a load method has been successfully called. This value is reset after each page is loaded, so if you are loading multiple pages, this error code is valid only for the last page.

If the last load method threw an exception, then this method should not be used, as its return value is undefined.

Note that this property is valid for the current thread. So it should be used in the same thread as the load method.

This is valid for all the methods that will load an image, including Load, LoadAsync or LoadSvg and FeedLoad.

Example

This example will load an image and check whether the image has corrupted areas.

C#
VB
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Svg; 
using LeadtoolsExamples.Common; 
 
void LoadStatusExample(string fileName) 
{ 
   RasterCodecs codecs = new RasterCodecs(); 
 
   try 
   { 
      RasterImage image = codecs.Load(fileName, 0, CodecsLoadByteOrder.Bgr, 1, 1); 
      RasterExceptionCode loadStatusCode = codecs.LoadStatus; 
      if (loadStatusCode == RasterExceptionCode.Success) 
         Console.WriteLine("The image was loaded successfully and with no errors"); 
      else 
         Console.WriteLine("The image was loaded, but it might have corrupted areas, error = {0}", loadStatusCode); 
 
      image.Dispose(); 
   } 
   catch (RasterException ex) 
   { 
      Console.WriteLine("LEADTOOLS could not load this image, error code is is '{0}', message is '{1}'", ex.Code, ex.Message); 
   } 
 
   // Clean up 
   codecs.Dispose(); 
} 
Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing 
Imports Leadtools.ImageProcessing.Color 
Imports Leadtools.Drawing 
Imports Leadtools.Svg 
 
Private Sub LoadStatusExample(ByVal fileName As String) 
   Dim codecs As RasterCodecs = New RasterCodecs() 
 
   Try 
      Dim image As RasterImage = codecs.Load(fileName, 0, CodecsLoadByteOrder.Bgr, 1, 1) 
      Dim loadStatusCode As RasterExceptionCode = codecs.LoadStatus 
      If loadStatusCode = RasterExceptionCode.Success Then 
         Console.WriteLine("The image was loaded successfully and with no errors") 
      Else 
         Console.WriteLine("The image was loaded, but it might have corrupted areas, error = {0}", loadStatusCode) 
      End If 
 
      image.Dispose() 
   Catch ex As RasterException 
      Console.WriteLine("LEADTOOLS could not load this image, error code is is '{0}', message is '{1}'", ex.Code, ex.Message) 
   End Try 
 
   ' Clean up 
   codecs.Dispose() 
End Sub 
c#[Silverlight C# Example] 
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Examples; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Windows.Media; 
 
void LoadStatusExample(Stream inStreamCorrupted) 
{ 
   RasterCodecs codecs = new RasterCodecs(); 
 
   try 
   { 
      RasterImage image = codecs.Load(inStreamCorrupted, 0, CodecsLoadByteOrder.Bgr, 1, 1); 
      RasterExceptionCode loadStatusCode = codecs.LoadStatus; 
      if (loadStatusCode == RasterExceptionCode.Success) 
         Debug.WriteLine("The image was loaded successfully and with no errors"); 
      else 
         Debug.WriteLine("The image was loaded, but it might have corrupted areas, error = {0}", loadStatusCode); 
 
      image.Dispose(); 
   } 
   catch (RasterException ex) 
   { 
      Debug.WriteLine("LEADTOOLS could not load this image, error code is is '{0}', message is '{1}'", ex.Code, ex.Message); 
   } 
} 
vb[Silverlight VB Example] 
Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing 
Imports Leadtools.ImageProcessing.Color 
Imports Leadtools.Windows.Media 
 
Private Sub LoadStatusExample(ByVal inStreamCorrupted As Stream) 
   Dim codecs As RasterCodecs = New RasterCodecs() 
 
   Try 
      Dim image As RasterImage = codecs.Load(inStreamCorrupted, 0, CodecsLoadByteOrder.Bgr, 1, 1) 
      Dim loadStatusCode As RasterExceptionCode = codecs.LoadStatus 
      If loadStatusCode = RasterExceptionCode.Success Then 
         Debug.WriteLine("The image was loaded successfully and with no errors") 
      Else 
         Debug.WriteLine("The image was loaded, but it might have corrupted areas, error = {0}", loadStatusCode) 
      End If 
 
      image.Dispose() 
   Catch ex As RasterException 
      Debug.WriteLine("LEADTOOLS could not load this image, error code is is '{0}', message is '{1}'", ex.Code, ex.Message) 
   End Try 
End Sub 

Requirements

Target Platforms

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

Leadtools.Codecs Assembly