#include "BITIFF.H"
BOOL CALLBACK GetTiffImage(TIFFFILE hChain, int iImage)
Description
This function registers an image in the image chain. It means that the image description data (the TIFF tags) for the selected image will be read from the associated TIFF file. This function does not decode or load the image itself! You should use DecodeTiffImage() for this purpose.
The image chain must have been opened with parameter T_READ in OpenTiffFile() or OpenTiffInMemory(). The image chain is zero based. The first image is 0.
Parameters
|
TIFFFILE |
hChain |
Valid TIFF image chain handle. |
|
int |
iImage |
The index of the image counted from the beginning of the image chain. The index of the first image is 0. |
Return values
TRUE on success, FALSE if iImage is negative or greater than the number of images in the TIFF file. It also returns FALSE in case of any other errors. Call TiffError() for the detailed description of the error.
Programming notes
If the image has already been registered it simply returns TRUE, otherwise it creates an inner structure for the image as well.
Requirements
Header : Declared in BiTiff.h; include BiTiff.h.
Library : Use BiTIFF.lib.
DLLs : BiTiff.dll.
References to related functions
See DropTiffImage() and DefineTiffImage().
Code example
See OpenTiffFile().