ReadStamp(string,int,CodecsImageInfo) Method

Summary

Reads a thumbnail image stored in the image file.

Syntax

Objective-C

C++/CLI

Python

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

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

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

def ReadStamp(self,fileName,pageNumber,info):

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, FlashPix, HEIF/HEIC, and PNG formats support stamps. However, not all files 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