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

For an example, refer to RasterCodecs.GetInformationAsync/

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