ReadStamp(string,int,CodecsImageInfo) Method

Summary

Reads a thumbnail image stored in the image file.

Syntax

Objective-C

C++

public RasterImage ReadStamp( 
   string fileName, 
   int pageNumber, 
   CodecsImageInfo info 
)

Public Overloads Function ReadStamp( _ 
   ByVal fileName As String, _ 
   ByVal pageNumber As Integer _ 
) As RasterImage

- (nullable LTRasterImage *)readStampFromFile:(NSString *)fileName  
                                   pageNumber:(NSInteger)pageNumber  
                                        error:(NSError **)error

public: 
RasterImage^ ReadStamp(  
   String^ fileName, 
   int pageNumber 
)

Parameters

fileName
A String containing the name of the file which contains the stamp image to load.

pageNumber
1-based index of the page from which the stamp image should be loaded.

info A CodecsImageInfo object containing information about the image.

Return Value

The RasterImage object that this method loads.

Remarks

Only EXIF, CMP, JPEG, and FlashPix formats support stamps. However, not all file of these formats contain stamps.

Both ReadStamp(String,Int32) and ReadStamp(String,Int32,CodecsImageInfo) read a thumbnail image from a string and load it into the specified image. The difference is that ReadStamp(String,Int32,CodecsImageInfo) takes a CodecsImageInfo object in order to improve performance.

To create a thumbnail image from any file, use ReadThumbnail.

NOTE: At this time, there are no multipage formats that support stamps.

Requirements

Target Platforms