ickFTP Component

The FTP component can be used to transfer files to and from FTP servers using the FTP Protocol. (NOTE: The following is a very short description. For more information, please consult the help files that come with the respective package.)

The FTP component uses Microsoft's Win32 Internet API to implement a generic FTP client. It can make use of the standard settings in the client PC for proxy servers as well as Internet Explorer's cache. The UseCache, ProxyServer, and ProxyBypass properties control their use.

The first step in using the component is specifying the RemoteHost, User and Password properties. The file to upload to, download from, or list is given by the RemoteFile property. The file to download to or upload from is specified by LocalFile. The current path in the server is specified by the RemotePath property. The Passive property is especially useful if the client is behind a firewall which inhibits incoming connections to higher ports.

The component operates by setting appropriate values to the Action property. If LocalFile is set to something other than an empty string, then files are received in LocalFile, otherwise the data is received through the Transfer event. StartTransfer and EndTransfer events are fired at the beginning and end of transmission.

You can get the received data also from the ReceiveBuffer property if you set ReceiveBufferSize accordingly. These properties are especially useful if you cannot handle events in your programming environment.

The Status event traces the interaction between the client and the server (the FTP Protocol Interface connection).

Formatted directory listings are received through the DirList event.

This component requires the Microsoft WinInet support libraries to be present in the host computer.

PROPERTIES

Action. An action code for the component.

AltFile. The new name for RemoteFile when Action is set to Rename.

LastReply. The last reply from the server.

LocalFile. The path to a local file for download/upload. If the file exists, it is overwritten.

Passive. Controls whether to direct the server into passive mode especially if behind a firewall.

Password. The password to login with.

ProxyBypass. Names or IP addresses of the hosts to be accessed directly (optional).

ProxyServer. Name or IP address of one or more proxy servers (optional).

ReceiveBuffer. A buffer with the incoming data of a transfer if ReceiveBufferSize is non-zero.

ReceiveBufferSize. Controls whether the received data is given in ReceiveBuffer and denotes its size.

RemoteFile. The name of the remote file for uploading/downloading.

RemoteHost. The domain name or IP address of the FTP server.

RemotePath. The current path in the FTP server.

RemotePort. The port for the FTP service (default is 21).

TransferMode. The transfer mode (ASCII or Binary). If left at Default, the initial server mode will be used.

UseCache. Make use of cache when transferring files, listing directories, etc.

User. The user id to login as.

WinInetVersion. Shows the version of the WinInet libraries.

EVENTS

DirList. Fired when a directory entry is received ('LIST' actions).

EndTransfer. Fired when a file completes downloading/uploading.

Status. Informs about the actions taken by the component while connecting to the server.

StartTransfer. Fired when a file starts downloading/uploading.

Transfer. Fired during file download/upload.