GetInformation(Uri,bool) Method

Summary

Gets the specific image page information from the specified Uri.

Syntax

C++

public CodecsImageInfo GetInformation( 
   Uri uri, 
   bool totalPages 
)

Public Overloads Function GetInformation( _ 
   ByVal uri As Uri, _ 
   ByVal totalPages As Boolean _ 
) As CodecsImageInfo

public: 
CodecsImageInfo^ GetInformation(  
   Uri^ uri, 
   bool totalPages 
)

Parameters

uri
The Uri containing the input image data.

totalPages
true to query the URI 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.

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.

To quickly query the number of an image, use GetTotalPages or GetTotalPagesAsync.

To quickly query the format of an image, use GetFormat or GetFormatAsync.

Example

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Svg; 
using LeadtoolsExamples.Common; 
 
public void GetInformationUriExample() 
{ 
   RasterCodecs codecs = new RasterCodecs(); 
 
   // Get Information on an image in an HTTP url 
   Uri uri = new Uri(@"https://www.leadtools.com/images/page_graphics/leadlogo.png"); 
   CodecsImageInfo info = codecs.GetInformation(uri, true); 
 
   Console.WriteLine("Information for: {0}", uri); 
   Console.WriteLine("BitsPerPixel: {0}", info.BitsPerPixel); 
   Console.WriteLine("BytesPerLine: {0}", info.BytesPerLine); 
   Console.WriteLine("ColorSpace: {0}", info.ColorSpace.ToString()); 
   Console.WriteLine("Compression: {0}", info.Compression); 
   Console.WriteLine("Format: {0}", info.Format); 
 
   // Clean up 
   codecs.Dispose(); 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing 
Imports Leadtools.ImageProcessing.Color 
Imports Leadtools.Drawing 
Imports Leadtools.Svg 
 
Public Sub GetInformationUriExample() 
   Dim codecs As New RasterCodecs() 
 
   ' Get Information on an image in an HTTP url 
   Dim uri As New Uri("https://www.leadtools.com/images/15-homepg-banner.jpg") 
   Dim info As CodecsImageInfo = codecs.GetInformation(uri, True) 
 
   Console.WriteLine("Information for: {0}", uri) 
   Console.WriteLine("BitsPerPixel: {0}", info.BitsPerPixel) 
   Console.WriteLine("BytesPerLine: {0}", info.BytesPerLine) 
   Console.WriteLine("ColorSpace: {0}", info.ColorSpace.ToString()) 
   Console.WriteLine("Compression: {0}", info.Compression) 
   Console.WriteLine("Format: {0}", info.Format) 
 
   ' Clean up 
   codecs.Dispose() 
End Sub