GetInformation(Stream,Boolean) Method

Gets the image information from a stream.

Syntax

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public CodecsImageInfo GetInformation( 
   Stream stream,
   bool totalPages
)

'Declaration
 
Public Overloads Function GetInformation( _
   ByVal stream As Stream, _
   ByVal totalPages As Boolean _
) As CodecsImageInfo

'Usage
 
Dim instance As RasterCodecs
Dim stream As Stream
Dim totalPages As Boolean
Dim value As CodecsImageInfo
 
value = instance.GetInformation(stream, totalPages)

public CodecsImageInfo GetInformation( 
   Stream stream,
   bool totalPages
)

 function Leadtools.Codecs.RasterCodecs.GetInformation(Stream,Boolean)( 
   stream ,
   totalPages 
)

public:
CodecsImageInfo^ GetInformation( 
   Stream^ stream,
   bool totalPages
)

Parameters

stream: System.IO.Stream containing the input image data.
totalPages: true to query the file for total number of pages; false, otherwise.

Return Value

A CodecsImageInfo object that contains the information about the specified image.

Remarks

Specifying true for totalPages can cause the process to be slow for files with large number of pages.

Example

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Public Sub GetInformationStreamExample()
      Dim codecs As RasterCodecs = New RasterCodecs()

      ' Get Information on a GIF image file and write it out
      Dim srcFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "eye.gif")
      Dim fileInMemory As FileStream = New FileStream(srcFileName, FileMode.Open)

      Dim info As CodecsImageInfo = codecs.GetInformation(fileInMemory, True)
      Console.WriteLine("Information for: {0}", srcFileName)
      Console.WriteLine(String.Format("BitsPerPixel: {0}", info.BitsPerPixel))
      Console.WriteLine(String.Format("BytesPerLine: {0}", info.BytesPerLine))
      Console.WriteLine(String.Format("ColorSpace: {0}", info.ColorSpace.ToString()))
      Console.WriteLine(String.Format("Compresion: {0}", info.Compression))
      Console.WriteLine(String.Format("Fax: {0}", info.Fax))
      Console.WriteLine(String.Format("Format: {0}", info.Format))
      If info.Gif.HasAnimationBackground Then
         Console.WriteLine(String.Format("Gif.AnimationBackground: {0}", info.Gif.AnimationBackground.ToString()))
      End If
      Console.WriteLine(String.Format("Gif.AnimationHeight: {0}", info.Gif.AnimationHeight))
      Console.WriteLine(String.Format("Gif.AnimationWidth: {0}", info.Gif.AnimationWidth))
      If info.Gif.HasAnimationLoop Then
         Console.WriteLine(String.Format("Gif.AnimationLoop: {0}", info.Gif.AnimationLoop.ToString()))
      End If
      If info.Gif.HasAnimationPalette Then
         Dim pal As RasterColor() = info.Gif.GetAnimationPalette()
         Console.WriteLine("GifAnimationPalette:" & Constants.vbLf)
         Dim x As Integer = 0
         Do While x < pal.Length
            Console.Write("{0},", pal(x))
            x += 1
         Loop
         Console.WriteLine(Constants.vbLf)
      End If
      Console.WriteLine(String.Format("Gif.IsInterlaced: {0}", info.Gif.IsInterlaced.ToString()))
      Console.WriteLine(String.Format("PageNumber: {0}", info.PageNumber))
      Console.WriteLine(String.Format("TotalPages: {0}", info.TotalPages))

      ' Clean up
      codecs.Dispose()
      fileInMemory.Close()
      fileInMemory.Dispose()
   End Sub

Public NotInheritable Class LEAD_VARS
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class

public void GetInformationStreamExample()
     {
         RasterCodecs codecs = new RasterCodecs();

         // Get Information on a GIF image file and write it out
         string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "eye.gif");
         FileStream fileInMemory = new FileStream(srcFileName, FileMode.Open);

         CodecsImageInfo info = codecs.GetInformation(fileInMemory, true);
         Console.WriteLine("Information for: {0}", srcFileName);
         Console.WriteLine(string.Format("BitsPerPixel: {0}", info.BitsPerPixel));
         Console.WriteLine(string.Format("BytesPerLine: {0}", info.BytesPerLine));
         Console.WriteLine(string.Format("ColorSpace: {0}", info.ColorSpace.ToString()));
         Console.WriteLine(string.Format("Compresion: {0}", info.Compression));
         Console.WriteLine(string.Format("Fax: {0}", info.Fax));
         Console.WriteLine(string.Format("Format: {0}", info.Format));
         if (info.Gif.HasAnimationBackground)
             Console.WriteLine(string.Format("Gif.AnimationBackground: {0}", info.Gif.AnimationBackground.ToString()));
         Console.WriteLine(string.Format("Gif.AnimationHeight: {0}", info.Gif.AnimationHeight));
         Console.WriteLine(string.Format("Gif.AnimationWidth: {0}", info.Gif.AnimationWidth));
         if (info.Gif.HasAnimationLoop)
             Console.WriteLine(string.Format("Gif.AnimationLoop: {0}", info.Gif.AnimationLoop.ToString()));
         if (info.Gif.HasAnimationPalette)
         {
             RasterColor[] pal = info.Gif.GetAnimationPalette();
             Console.WriteLine("GifAnimationPalette:\n");
             for (int x = 0; x < pal.Length; x++)
             {
                 Console.Write("{0},", pal[x]);
             }
             Console.WriteLine("\n");
         }
         Console.WriteLine(string.Format("Gif.IsInterlaced: {0}", info.Gif.IsInterlaced.ToString()));
         Console.WriteLine(string.Format("PageNumber: {0}", info.PageNumber));
         Console.WriteLine(string.Format("TotalPages: {0}", info.TotalPages));

         // Clean up
         codecs.Dispose();
         fileInMemory.Close();
         fileInMemory.Dispose();
     }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}

public void GetInformationStreamExample(Stream inStreamGif)
{
   RasterCodecs codecs = new RasterCodecs();
   // Get Information on a GIF image file and write it out
   CodecsImageInfo info = codecs.GetInformation(inStreamGif, true);
   Debug.WriteLine(string.Format("BitsPerPixel: {0}", info.BitsPerPixel));
   Debug.WriteLine(string.Format("BytesPerLine: {0}", info.BytesPerLine));
   Debug.WriteLine(string.Format("ColorSpace: {0}", info.ColorSpace.ToString()));
   Debug.WriteLine(string.Format("Compresion: {0}", info.Compression));
   Debug.WriteLine(string.Format("Fax: {0}", info.Fax));
   Debug.WriteLine(string.Format("Format: {0}", info.Format));
   if(info.Gif.HasAnimationBackground)
      Debug.WriteLine(string.Format("Gif.AnimationBackground: {0}", info.Gif.AnimationBackground.ToString()));
   Debug.WriteLine(string.Format("Gif.AnimationHeight: {0}", info.Gif.AnimationHeight));
   Debug.WriteLine(string.Format("Gif.AnimationWidth: {0}", info.Gif.AnimationWidth));
   if(info.Gif.HasAnimationLoop)
      Debug.WriteLine(string.Format("Gif.AnimationLoop: {0}", info.Gif.AnimationLoop.ToString()));
   if(info.Gif.HasAnimationPalette)
   {
      RasterColor[] pal = info.Gif.GetAnimationPalette();
      Debug.WriteLine("GifAnimationPalette:\n");
      for(int x = 0; x < pal.Length; x++)
      {
         Debug.WriteLine("{0},", pal[x]);
      }
      Debug.WriteLine("\n");
   }
   Debug.WriteLine(string.Format("Gif.IsInterlaced: {0}", info.Gif.IsInterlaced.ToString()));
   Debug.WriteLine(string.Format("PageNumber: {0}", info.PageNumber));
   Debug.WriteLine(string.Format("TotalPages: {0}", info.TotalPages));

   // Clean up
   inStreamGif.Close();
   inStreamGif.Dispose();
}

Public Sub GetInformationStreamExample(ByVal inStreamGif As Stream)
   Dim codecs As RasterCodecs = New RasterCodecs()
   ' Get Information on a GIF image file and write it out
   Dim info As CodecsImageInfo = codecs.GetInformation(inStreamGif, True)
   Debug.WriteLine(String.Format("BitsPerPixel: {0}", info.BitsPerPixel))
   Debug.WriteLine(String.Format("BytesPerLine: {0}", info.BytesPerLine))
   Debug.WriteLine(String.Format("ColorSpace: {0}", info.ColorSpace.ToString()))
   Debug.WriteLine(String.Format("Compresion: {0}", info.Compression))
   Debug.WriteLine(String.Format("Fax: {0}", info.Fax))
   Debug.WriteLine(String.Format("Format: {0}", info.Format))
   If info.Gif.HasAnimationBackground Then
      Debug.WriteLine(String.Format("Gif.AnimationBackground: {0}", info.Gif.AnimationBackground.ToString()))
   End If
   Debug.WriteLine(String.Format("Gif.AnimationHeight: {0}", info.Gif.AnimationHeight))
   Debug.WriteLine(String.Format("Gif.AnimationWidth: {0}", info.Gif.AnimationWidth))
   If info.Gif.HasAnimationLoop Then
      Debug.WriteLine(String.Format("Gif.AnimationLoop: {0}", info.Gif.AnimationLoop.ToString()))
   End If
   If info.Gif.HasAnimationPalette Then
      Dim pal As RasterColor() = info.Gif.GetAnimationPalette()
      Debug.WriteLine("GifAnimationPalette:" & Constants.vbLf)
      Dim x As Integer = 0
      Do While x < pal.Length
         Debug.WriteLine("{0},", pal(x))
         x += 1
      Loop
      Debug.WriteLine(Constants.vbLf)
   End If
   Debug.WriteLine(String.Format("Gif.IsInterlaced: {0}", info.Gif.IsInterlaced.ToString()))
   Debug.WriteLine(String.Format("PageNumber: {0}", info.PageNumber))
   Debug.WriteLine(String.Format("TotalPages: {0}", info.TotalPages))

   ' Clean up
   inStreamGif.Close()
   inStreamGif.Dispose()
End Sub

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

RasterCodecs Class
RasterCodecs Members
Overload List
Loading and Saving Large Tiff Files
Speeding Up 1-Bit Documents
Fast File Info