GetInformationAsync(RasterCodecs,ILeadStream,bool,int) Method

Summary

Asynchronously gets the image information about a specific page from a stream containing image data.

Syntax

public static Task<CodecsImageInfo> GetInformationAsync( 
   this RasterCodecs rasterCodecs, 
   ILeadStream stream, 
   bool totalPages, 
   int pageNumber 
)

Parameters

rasterCodecs

RasterCodecs object to perform the operation.

stream

Stream containing the input image data to query.

totalPages

true to query the file for total number of pages; false, otherwise.

pageNumber

The page number to query. Pass 1 for the first page (default).

Return Value

A Task that represents the asynchronous operation. TResult: CodecsImageInfo object that contains the information about the specified image. See remarks about the usage of this object.

Remarks

This topic is part of RasterCodecs support for .NET async/await support. Refer to RasterCodecs Async Operations for more information.

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

The RasterCodecs class supports getting information on image files asynchronously using the GetInformationAsync methods.

Example

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Svg; 
 
 
public async void GetInformationAsyncExample() 
{ 
   // For .NET Framework: Add a reference to Leadtools.Async to get the async support as extension methods 
   // For .NET Standard: async support is included. 
 
   // Get Information on a TIF image file and write it out 
   string address = @"https://demo.leadtools.com/images/tiff/ocr1.tif"; 
   Uri uri = new Uri(address); 
 
   using (RasterCodecs codecs = new RasterCodecs()) 
   { 
      // Create an ILeadStream object to the URI 
      using (ILeadStream leadStream = await LeadStream.Factory.FromUri(uri)) 
      { 
         using (CodecsImageInfo info = await codecs.GetInformationAsync(leadStream, true)) 
         { 
            Debug.WriteLine("Information for: {0}", uri); 
            Debug.WriteLine("Format: {0}", info.Format); 
            Debug.WriteLine("Width: {0}", info.Width); 
            Debug.WriteLine("Height: {0}", info.Height); 
            Debug.WriteLine("BitsPerPixel: {0}", info.BitsPerPixel); 
            Debug.WriteLine("BytesPerLine: {0}", info.BytesPerLine); 
            Debug.WriteLine("PageNumber: {0}", info.PageNumber); 
            Debug.WriteLine("TotalPages: {0}", info.TotalPages); 
         } 
      } 
   } 
}

Requirements

For .NET Framework: A reference to the Leadtools.Async.dll assembly is required to use this functionality.

For .NET Standard: This functionality is included in the Leadtools.Codecs.dll assembly.

Target Platforms

Reference

RasterCodecs Class

RasterCodecs Members

Leadtools.Codecs Namespace

Download our FREE evaluation

Help Version 22.0.2023.5.5

Leadtools.Codecs Assembly

Introduction

Getting Started

Namespaces

Leadtools.Codecs Namespace

Assemblies