LEADTOOLS Image File Support (Leadtools.Codecs assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
LoadStatus Property
See Also 
Leadtools.Codecs Namespace > RasterCodecs Class : LoadStatus Property



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

Syntax

Visual Basic (Declaration) 
Public ReadOnly Property LoadStatus As RasterExceptionCode
Visual Basic (Usage)Copy Code
Dim instance As RasterCodecs
Dim value As RasterExceptionCode
 
value = instance.LoadStatus
C# 
public RasterExceptionCode LoadStatus {get;}
C++/CLI 
public:
property RasterExceptionCode LoadStatus {
   RasterExceptionCode get();
}

Property Value

A Leadtools.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.

Example

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

Visual BasicCopy Code
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#Copy Code
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();
}
SilverlightCSharpCopy Code
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);
   }
}
SilverlightVBCopy Code
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

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 sucessfully 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 RasterCodecs.Load, RasterCodecs.LoadAsync and FeedLoad(Byte[],Int32,Int32).

Requirements

Target Platforms: Silverlight, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only)

See Also