FTP Class

Properties   Methods   Events   Configuration Settings   Errors  

The FTP Component can be used to transfer files to and from FTP servers using the FTP Protocol.

Class Name

IPWorks_FTP

Procedural Interface

 ipworks_ftp_open();
 ipworks_ftp_close($res);
 ipworks_ftp_register_callback($res, $id, $function);
 ipworks_ftp_get_last_error($res);
 ipworks_ftp_get_last_error_code($res);
 ipworks_ftp_set($res, $id, $index, $value);
 ipworks_ftp_get($res, $id, $index);
 ipworks_ftp_do_abort($res);
 ipworks_ftp_do_append($res);
 ipworks_ftp_do_config($res, $configurationstring);
 ipworks_ftp_do_deletefile($res, $filename);
 ipworks_ftp_do_doevents($res);
 ipworks_ftp_do_download($res);
 ipworks_ftp_do_interrupt($res);
 ipworks_ftp_do_listdirectory($res);
 ipworks_ftp_do_listdirectorylong($res);
 ipworks_ftp_do_logoff($res);
 ipworks_ftp_do_logon($res);
 ipworks_ftp_do_makedirectory($res, $newdir);
 ipworks_ftp_do_removedirectory($res, $dirname);
 ipworks_ftp_do_renamefile($res, $newname);
 ipworks_ftp_do_storeunique($res);
 ipworks_ftp_do_upload($res);

Remarks

The FTP Class implements a standard FTP client as specified in RFC 959 and RFC 1579.

The first step in using the class is specifying the RemoteHost, User and Password. The file to upload to or download from 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.

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 are fired at the beginning and end of transmission.

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

Directory listings are received through the DirList event.