SFTP Class

Properties   Methods   Events   Configuration Settings   Errors  

The SFTP component can be used to transfer files to and from SFTP servers using the SFTP Protocol.

Class Name

IPWorksSSH_SFTP

Procedural Interface

 ipworksssh_sftp_open();
 ipworksssh_sftp_close($res);
 ipworksssh_sftp_register_callback($res, $id, $function);
 ipworksssh_sftp_get_last_error($res);
 ipworksssh_sftp_get_last_error_code($res);
 ipworksssh_sftp_set($res, $id, $index, $value);
 ipworksssh_sftp_get($res, $id, $index);
 ipworksssh_sftp_do_append($res);
 ipworksssh_sftp_do_config($res, $configurationstring);
 ipworksssh_sftp_do_decodepacket($res, $encodedpacket);
 ipworksssh_sftp_do_deletefile($res, $filename);
 ipworksssh_sftp_do_doevents($res);
 ipworksssh_sftp_do_download($res);
 ipworksssh_sftp_do_encodepacket($res, $packet);
 ipworksssh_sftp_do_getsshparam($res, $payload, $field);
 ipworksssh_sftp_do_getsshparambytes($res, $payload, $field);
 ipworksssh_sftp_do_interrupt($res);
 ipworksssh_sftp_do_listdirectory($res);
 ipworksssh_sftp_do_makedirectory($res, $newdir);
 ipworksssh_sftp_do_queuefile($res, $localfile, $remotefile);
 ipworksssh_sftp_do_removedirectory($res, $dirname);
 ipworksssh_sftp_do_renamefile($res, $newname);
 ipworksssh_sftp_do_resetqueue($res);
 ipworksssh_sftp_do_setsshparam($res, $payload, $fieldtype, $fieldvalue);
 ipworksssh_sftp_do_sshlogoff($res);
 ipworksssh_sftp_do_sshlogon($res, $sshhost, $sshport);
 ipworksssh_sftp_do_updatefileattributes($res);
 ipworksssh_sftp_do_upload($res);

Remarks

The SFTP class is the SSH-enabled equivalent of the IP*Works! FTP class. The main difference is the introduction of a set of new properties and events that deal with SSH security. The SSHHost and SSHPort properties specify the SSH server to use. The SSHUser and SSHPassword properties allow the client to authenticate itself with the server. The SSHServerAuthentication event and/or SSHAcceptServerHostKey property allow you to check the server identity. Finally, the SSHStatus event provides information about the SSH handshake.

The SFTP class implements a standard SSH File Transfer client.

The first step in using the class is specifying the SSHHost, SSHUser and SSHPassword. 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.

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.

Directory listings are received through the DirList event.