IKFileLoad

This function loads image data from a file.

[C++Builder] HANDLE IKFileLoad(LPCTSTR FileName, int Page, long Width, long Height, IKPROCESSPROC UserProc, LPCTSTR Caption, LPCTSTR Message, LPCTSTR Button);

[Delphi] function IKFileLoad(FileName: PChar; Page: Integer; Width, Height: Longint; UserProc: LONG_PTR; Caption, Message, Button: PChar): THandle;

Parameters

Name	Explanation
FileName	The name of the image file that is loaded
Page	The page number of the file that is loaded into the memory (starts from 0)
Width	The width of the loaded image (in pixels)
Height	The height of the loaded image (in pixels)
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 or vector image if successful. Returns 0 if unsuccessful.

Explanation

The IKFileLoad function loads image data from a file. This function automatically recognizes the following formats: BMP, DXF, EMF, FPX, GIF, JPEG, JPEG200, PCX, PNG, SXF, SVG, TIFF, and WMF. NOTE: For TIFF(JPEG Compression), some TIFF(JPEG) images cannot be loaded by the ImageKit.

When loading multi-page image files or multi-resolution image files (FPX), the Page parameter determines which page will be loaded. If the image is a single page image file then the Page parameter is disabled. When loading a raster image, the values in the Width and Height parameters are ignored. These parameters are only enabled when loading vector images. If the Width parameter is 0 or less and the image is DXF, SXF, or WMF, then the default image width of 800 is used. If the image is EMF or SVG then the width is retrieved from the EMF or SVG file header. Likewise, if the Height parameter is 0 or less and the image is DXF, SXF, or WMF, then the default image height of 600 is used. If the image is EMF or SVG then the Height is retrieved from the EMF or SVG file header.

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.

To execute this function, you must first execute the Ik10VectCom.dll, Ik10VectComA.dll, Ik10VectCom64.dll, and Ik10VectCom64A.dll's IKVectorGdipStart function.

Note: When a vector image is loaded, the ratio of the height and width of the original image is maintained and the largest pixel size of the image is scaled within the area defined by the Height and Width parameters.

It is possible to load a file directly from FTP server or HTTP(S) server by setting the FTP or HTTP(S) server name in the FileName parameter.

(1) When loading the file from a local drive or network drive:
IKFileLoad("c:\abc.jpg", .....)

(2) When loading the file from FTP server:
IKFileLoad("FTP://www.newtone.co.jp/image/abc.jpg;;;true;user;password", .....)

(*)Parameter order when setting the FileName:
FTP://ServerName/FolderName/FileName;ProxyName;PortNumber;PassiveMode;UserName;Password

When setting or changing the proxy server, the port number, and passive (PASV) mode connection, please be sure to pass in this information seperated by semicolons. Set the FTP server name or IP address, the proxy server name or IP address, the port number, passive mode connection, etc. If the port number is omitted, the defaul port number will be used. Passive mode connection can be either "true" or "false" in upper case or lower case letters. If omitted, passive mode connection will be used.

(3) When loading the file from HTTP(S) server:
IKFileLoad("http://www.newtone.co.jp/image/abc.jpg;;;;user;password", .....)

(*)Parameter order when setting the FileName:
HTTP://ServerName/FolderName/FileName;ProxyName;PortNumber;HTTPS;UserName;Password

When setting or changing the proxy server, the port number, or using HTTPS, please be sure to pass in this information seperated by semicolons. Set the HTTP(S) server name or IP address, the proxy server name or IP address, the port number, HTTPS, etc. If the port number is omitted, the defaul port number will be used. IF HTTPS is omitted then HTTP server will be used.

[Differences from the ImageKit5]

Function Name	Parameters
IK5FileLoad:	FileName, Page, FileUserProc, Caption, Message, Button
IKFileLoad:	FileName, Page, Width, Height, UserProc, Caption, Message, Button

The Width and Height parameters have been added but they are not enabled when loading raster images. In this case this function is the same as in the ImageKit5. Note: FileUserProc and UserProc refer to the same user function.

[Differences from ImageKit7 ActiveX]
The ImageKit7 ActiveX only allowed files from local drives or network drives to be loaded. Now images may also be loaded from FTP or HTTP(S) servers.