←Select platform

LoadAsync(ILeadStream) Method

Summary

Loads an image stream using the specified options asynchronously.

Syntax

WinRT C#

C++

public IAsyncOperation<RasterImage> LoadAsync(  
   ILeadStream stream 
)

Public Overloads Function LoadAsync( _ 
   ByVal stream As ILeadStream _ 
) As IAsyncOperation(Of RasterImage)

public IAsyncOperation<RasterImage> LoadAsync(  
   ILeadStream stream 
)

 function Leadtools.Codecs.RasterCodecs.LoadAsync(ILeadStream)(  
   stream  
)

public: 
IAsyncOperation<RasterImage^>^ LoadAsync(  
   ILeadStream^ stream 
)

Parameters

stream
An ILeadStream containing the image data to load.

Return Value

When this method completes, it returns the image as a RasterImage.

Remarks

LEADTOOLS will attempt to load corrupted files so you can see at least a portion of the image. For such images, the load methods succeed, but the LoadStatus will return an error code.

Use the CodecsLoadOptions class to set up other load option parameters before calling this method.

Support for 12 and 16-bit grayscale images is only available in the Document/Medical Imaging editions.

For supported formats, refer to Summary of All Supported Image File Formats.

LEADTOOLS loads all PDF files as Raster PDF uncompressed RasterImageFormat.RasPdf, regardless of the compression and color space used when saving the file.

The RasterCodecs class supports loading image files asynchronously using the LoadAsync methods. When calling any of these methods, the caller thread will not be blocked and the method will return instantly with an instance of RasterImage that is in a loading status (RasterImage.IsLoading set to true). Do not use the other properties of this object while the object is in loading status.

When the RasterCodecs object finishes loading the image, the various properties of the RasterImage will be populated with the image information and data and the RasterImage.IsLoading property will be set to false.

Do not poll the RasterImage.IsLoading property to whether the image has finished loading. Instead, subscribe to the IAsyncOperation.Completed event to get notification when the LoadAsync operation has completed and whether any errors occurred.

When this method completes, it returns the image as a RasterImage.

The CodecsLoadOptions.AllPages property controls whether RasterCodecs will try to load all pages or just the first page if the image data contains multiple pages. To load a single page, use LoadAsync(ILeadStream stream, int pageNumber).

Requirements

Target Platforms