ReadThumbnail(Stream,CodecsThumbnailOptions,int) Method

Summary

Creates a thumbnail from the specified image stream.

Syntax

Objective-C

C++

Java

public RasterImage ReadThumbnail( 
   Stream stream, 
   CodecsThumbnailOptions options, 
   int pageNumber 
)

Public Overloads Function ReadThumbnail( _ 
   ByVal stream As Stream, _ 
   ByVal options As CodecsThumbnailOptions, _ 
   ByVal pageNumber As Integer _ 
) As RasterImage

- (nullable LTRasterImage *)readThumbnailFromStream:(LTLeadStream *)stream  
                                            options:(LTCodecsThumbnailOptions *)thumbnailOptions  
                                         pageNumber:(NSInteger)pageNumber  
                                              error:(NSError **)error

public RasterImage readThumbnail(ILeadStream stream, CodecsThumbnailOptions options, int pageNumber)

public: 
RasterImage^ ReadThumbnail(  
   Stream^ stream, 
   CodecsThumbnailOptions options, 
   int pageNumber 
)

Parameters

stream
A Stream containing the image data from which the thumbnail image will be created.

options
Options for creating the thumbnail image.

pageNumber
1-based index of the page from which the thumbnail image should be created.

Return Value

The RasterImage object that this method creates.

Remarks

This method will always return a thumbnail image. Depending on the options passed, this method might read the stamp stored inside EXIF, CMP, JFIF and FlashPix files and return that. To read the file stamp only, use ReadStamp.

Example

For an example, refer to ReadThumbnail.

Requirements

Target Platforms