GetInformationAsync(Uri,bool,int,object) Method

Summary

Gets the specific image page information from the specified Uri asynchronously.

Syntax

C++

public CodecsImageInfo GetInformationAsync( 
   Uri uri, 
   bool totalPages, 
   int pageNumber, 
   object userState 
)

Public Overloads Function GetInformationAsync( _ 
   ByVal uri As Uri, _ 
   ByVal totalPages As Boolean, _ 
   ByVal pageNumber As Integer, _ 
   ByVal userState As Object _ 
) As CodecsImageInfo

public: 
CodecsImageInfo^ GetInformationAsync(  
   Uri^ uri, 
   bool totalPages, 
   int pageNumber, 
   Object^ userState 
)

Parameters

uri
The Uri containing the input image data.

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

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

userState
A user-defined object that is passed to the method invoked when the asynchronous operation completes.

Return Value

A CodecsImageInfo object that contains the information about the specified image. See remarks about the usage of this object.

Remarks

NOTE: This topic is part of RasterCodecs Async support using the .NET System.ComponentMode.AsyncOperation model. For .NET async/await, use Task<CodecsImageInfo> GetInformationAsync(ILeadStream stream, bool totalPages, int pageNumber).

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

LEADTOOLS supports the following URI schemes:

Scheme	Description
UriSchemeFile	Specifies that the URI is a disk file in local machine or universal naming convention (UNC) path.
UriSchemeHttp	Specifies that the URI is accessed through the Hypertext Transfer Protocol (HTTP).
UriSchemeHttps	Specifies that the URI is accessed through the Secure Hypertext Transfer Protocol (HTTPS).
UriSchemeFtp	Specifies that the URI is accessed through the File Transfer Protocol (FTP).

If uri points to a resource in a UriSchemeHttp, UriSchemeHttps or UriSchemeFtp, then this RasterCodecs will attempt to download image data in an iterative fashion by creating a temporary buffer. The size of this buffer can be determined and changed by setting up the UriOperationBufferSize prior to calling this method.

For authenticity and proxy settings, refer to UriOperationCredentials and UriOperationProxy.

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

When the RasterCodecs object finishes getting the information about the file, the various properties of the CodecsImageInfo will be populated with the image file information and the CodecsImageInfo.IsLoading property will be set to false.

It is recommended that you do not poll for the CodecsImageInfo.IsLoading property to determine whether the image information has been collected. Instead, subscribe to the GetInformationAsyncCompleted event to get notification on when the GetInformationAsync operation is completed and whether any errors occurred.

The GetInformationAsyncCompleted event data will also contain the same object returned from GetInformationAsync so you do not have to keep the original object in your application. userState will be passed to the CodecsGetInformationAsyncCompletedEventArgs.UserState member of the GetInformationAsyncCompleted event data.

Example

For an example, refer to GetInformationAsyncCompleted.

Requirements

Target Platforms