←Select platform

GetInformation(string,bool,int) Method

Summary

Gets the specific image page information from a disk file.

Syntax
C#
VB
Objective-C
C++
public CodecsImageInfo GetInformation( 
   string fileName, 
   bool totalPages, 
   int pageNumber 
) 
Public Overloads Function GetInformation( _ 
   ByVal fileName As String, _ 
   ByVal totalPages As Boolean, _ 
   ByVal pageNumber As Integer _ 
) As CodecsImageInfo 
- (nullable LTCodecsImageInfo *)imageInformationForFile:(NSString *)file  
                                             totalPages:(BOOL)totalPages  
                                             pageNumber:(NSInteger)pageNumber  
                                                  error:(NSError **)error 
public: 
CodecsImageInfo^ GetInformation(  
   String^ fileName, 
   bool totalPages, 
   int pageNumber 
)

Parameters

fileName
String containing the input file name to query.

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

pageNumber
Page number in the file to query.

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.

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

For an example, refer to GetInformation.

Requirements

Target Platforms

Help Version 20.0.2020.4.3
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Codecs Assembly
Introduction
Getting Started
Namespaces
Leadtools.Codecs Namespace
Assemblies