LocalFile Property

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

Object Oriented Interface

public function getLocalFile();
public function setLocalFile($value);

Procedural Interface

ipworksssh_scp_get($res, 9 );
ipworksssh_scp_set($res, 9, $value );

Default Value

''

Remarks

The LocalFile property is used by the Upload and Download methods. See the method descriptions for more information.

Example (Setting LocalFile)

SCPControl.Localfile = "C:\localfile.txt"
SCPControl.RemoteFile = "remotefile.txt"
SCPControl.Download()

SCPControl.Localfile = "C:\localfile2.txt"
SCPControl.RemoteFile = "folder/remotefile2.txt"
SCPControl.Upload()

Multiple file uploads and downloads are supported through the use of filemasks.

To upload files matching a filemask set LocalFile to a local path including a filemask. Set RemotePath to the directory on the server where the files will be uploaded. In this case RemoteFile is ignored. All matching files will be upload when Upload is called. The StartTransfer, Transfer, and EndTransfer events provide details about the individual file transfers.

To download files matching a filemask set RemoteFile to a filemask. The path may be specified as part of the value in RemoteFile or may be set separately in RemotePath. LocalFile should be set to a local directory where files will be downloaded. When Download is called all matching files are downloaded. The StartTransfer, Transfer, and EndTransfer events provide details about the individual file transfers. In the event an individual file fails to transfer the Error event will fire.

Data Type

String