FTPGetFile (ImageKit Control/File Method)

This method retrieves an existing file from the FTP server. (It includes connecting to and disconnecting from the server.)

[Visual Basic] [ Boolean = ]imagekitcontrolname.File.FTPGetFile(ServerName As String, ProxyName As String, PortNo As Integer, PassiveMode As Boolean, RemoteFilePath As String, UserName As String, Password As String, TransPercent As Long)

[Visual C++] [ BOOL = ]imagekitcontrolname.GetFile().FTPGetFile(LPCTSTR ServerName, LPCTSTR ProxyName, short PortNo, BOOL PassiveMode, LPCTSTR RemoteFilePath, LPCTSTR UserName, LPCTSTR Password, long TransPercent)

Parameters

Name	Explanation
ServerName	The name of the FTP server or IPAddress
ProxyName	The Proxy Server IP Address
PortNo	Port Number (default is 21)
PassiveMode	Enables passive mode connectivity: False(0) = Active Mode Connection; True(nonzero) = Passive Mode Connection
RemoteFilePath	The name and path of the file to be retrieved
UserName	The username needed to access the FTP server
Password	The password needed to access the FTP server
TransPercent	The percentage of the file that is tranferred before the ImageKit Progress event is generated

Return Value

Returns True (nonzero) if successful. Returns False (0) if unsuccessful.

Explanation

The FTPGetFile method retrieves an existing file from the FTP server. (It includes connecting to and disconnecting from the 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.

When not using a proxy server set an empty string, set to NULL(Visual C++) or vbNullString(Visual Basic)