Leadtools.Codecs Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
Load(Stream) Method
See Also  Example
Leadtools.Codecs Namespace > RasterCodecs Class > Load Method : Load(Stream) Method



stream
A Stream containing the image data to load.
Loads the specified image stream using default options.

Syntax

Visual Basic (Declaration) 
Public Overloads Function Load( _
   ByVal stream As Stream _
) As RasterImage
Visual Basic (Usage)Copy Code
Dim instance As RasterCodecs
Dim stream As Stream
Dim value As RasterImage
 
value = instance.Load(stream)
C# 
public RasterImage Load( 
   Stream stream
)
C++/CLI 
public:
RasterImage Load( 
   Stream^ stream
)

Parameters

stream
A Stream containing the image data to load.

Return Value

The RasterImage object that this method loads.

Example

This example will load all the pages from a stream that contains a single multipage file

Visual BasicCopy Code
Public Sub LoadStream1Example()
   RasterCodecs.Startup()
   Dim codecs As RasterCodecs = New RasterCodecs()

   Dim singlePageFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "Image1.cmp"
   Dim multiPageFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "Eye.gif"

   ' Load the file into a stream
   Dim fs As FileStream = File.OpenRead(singlePageFileName)

   ' Get the file information (we are interested in the number of pages)
   Dim info As CodecsImageInfo = codecs.GetInformation(fs, True)
   Console.WriteLine("Number of pages according to info: {0}", info.TotalPages)

   ' Load the image and verify that we loaded all the pages
   Dim image As RasterImage = codecs.Load(fs)
   Console.WriteLine("Number of pages loaded: {0}", image.PageCount)
   Debug.Assert(image.PageCount = info.TotalPages)

   image.Dispose()
   fs.Close()

   ' Repeat for a multipage file

   fs = File.OpenRead(multiPageFileName)

   info = codecs.GetInformation(fs, True)
   Console.WriteLine("Number of pages according to info: {0}", info.TotalPages)

   image = codecs.Load(fs)
   Console.WriteLine("Number of pages loaded: {0}", image.PageCount)
   Debug.Assert(image.PageCount = info.TotalPages)

   image.Dispose()
   fs.Close()

   ' Clean up
   codecs.Dispose()
   RasterCodecs.Shutdown()
End Sub
C#Copy Code
public void LoadStream1Example() 
{ 
   RasterCodecs.Startup(); 
   RasterCodecs codecs = new RasterCodecs(); 
 
   string singlePageFileName = LeadtoolsExamples.Common.ImagesPath.Path + "Image1.cmp"; 
   string multiPageFileName = LeadtoolsExamples.Common.ImagesPath.Path + "Eye.gif"; 
 
   // Load the file into a stream 
   FileStream fs = File.OpenRead(singlePageFileName); 
 
   // Get the file information (we are interested in the number of pages) 
   CodecsImageInfo info = codecs.GetInformation(fs, true); 
   Console.WriteLine("Number of pages according to info: {0}", info.TotalPages); 
 
   // Load the image and verify that we loaded all the pages 
   RasterImage image = codecs.Load(fs); 
   Console.WriteLine("Number of pages loaded: {0}", image.PageCount); 
   Debug.Assert(image.PageCount == info.TotalPages); 
 
   image.Dispose(); 
   fs.Close(); 
 
   // Repeat for a multipage file 
 
   fs = File.OpenRead(multiPageFileName); 
 
   info = codecs.GetInformation(fs, true); 
   Console.WriteLine("Number of pages according to info: {0}", info.TotalPages); 
 
   image = codecs.Load(fs); 
   Console.WriteLine("Number of pages loaded: {0}", image.PageCount); 
   Debug.Assert(image.PageCount == info.TotalPages); 
 
   image.Dispose(); 
   fs.Close(); 
 
   // Clean up 
   codecs.Dispose(); 
   RasterCodecs.Shutdown(); 
}

Remarks

The stream can point to any supported image file format and bits per pixel, whether compressed or uncompressed.

This method will load all the pages in a multipage file. The resulting image will have the same bits/pixel and color order value of the image as it was stored in the stream.

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

Use the CodecsLoadOptions class to set up other load options 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.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also