IKTiffFileLoad

This function loads raster image data from a TIFF file.

[C++Builder] HANDLE IKTiffFileLoad(LPCTSTR FileName, int Page, IKPROCESSPROC UserProc, LPCTSTR Caption, LPCTSTR Message, LPCTSTR Button);

[Delphi] function IKTiffFileLoad(FileName: PChar; Page: Integer; UserProc: LONG_PTR; Caption, Message, Button: PChar): THandle;

Parameters

Name	Explanation
FileName	The name of the image file that is loaded
UserProc	The address of the user function (If not using the user function then set to 0)
Caption	Sets the text displayed in the title bar of the progress dialog box
Message	Sets the message displayed in the progress dialog box
Button	Sets the name of the button displayed in the progress dialog box

Return Value

Returns the image handle of the raster image if successful. Returns 0 if unsuccessful.

Explanation

The IKTiffFileLoad function loads raster image data from a TIFF file. When loading multi-page image files, the Page parameter determines which page will be loaded. If the image is a single page image file then the Page parameter is disabled. Supports 1, 4, 8, 16, 24, and 32 bit color. (This differs depending on the compression mode). The number of pages in a multi-page image file can be retrieved by IkFileType.

NOTE: For TIFF(JPEG Compression), some TIFF(JPEG) images cannot be loaded by the ImageKit.

If the user function is set or if the Caption, Message, and Button parameters are blank then the Progress dialog box is not displayed. If the Progress dialog box is displayed, it indicates the percentage of the current process completed. For more information about the user function please refer to the Definition of User Function in the Ik10File.dll, Ik10FileA.dll, Ik10File64.dll, Ik10File64A.dll section.