HTTPGetFileEx (ImageKit Control/FileIO Method)

This method retrieves a file from the HTTP(S) server.

[C++Builder] [ bool = ]imagekitcontrolname->FileIO->HTTPGetFileEx(const UnicodeString RemoteFilePath, int TransPercent)

[Delphi] [ Boolean = ]imagekitcontrolname.FileIO.HTTPGetFileEx(const RemoteFilePath: string; TransPercent: Integer)

Parameters

Name	Explanation
RemoteFilePath	The name and path of the file to be retrieved
TransPercent	The percentage of the file that is tranferred before the ImageKit Progress event is generated

Return Value

Returns True if successful. Returns False if unsuccessful.

Explanation

The HTTPGetFileEx method retrieves a file from the HTTP(S) server. This method can only be used after the HTTPConnect method has connected to the HTTP(S) server.This method can only be executed from the client computer. It does not operate on the server. The TransPercent parameter sets the amount of transfer in percentage before the ImageKit Progress event fires. For example, if the TransPercent = 10, the ImageKit Progress event will fire 10 times, 1 time for each 10% of file transferred.

The retrieved file is saved in the location specified by the FileName property.

Example Code:

C++Builder
if (VImageKit1->FileIO->HTTPConnect("www.newtone.co.jp", "", 443, true, "User", "Password") == false) return;
VImageKit1->FileIO->FileName = "C:\\Images\\001.jpg";
VImageKit1->FileIO->HTTPGetFileEx("images/001.jpg", 10);
VImageKit1->FileIO->HTTPDisconnect();

Delphi
if (VImageKit1.FileIO.HTTPConnect('www.newtone.co.jp', '', 443, True, 'User', 'Password') = False) then Exit;
VImageKit1.FileIO.FileName := 'C:\Images\001.jpg';
VImageKit1.FileIO.HTTPGetFileEx('images/001.jpg', 10);
VImageKit1.FileIO.HTTPDisconnect();