Method SFTPClient():getFile()

Downloads a file.

:getFile( <cRemoteFile>, [<cLocalFile>], [<bProgressBlock>] ) --> lSuccess

The relative or fully qualified path of the remote file to download.

The relative or fully qualified path of the local file. The parameter is optional. If no path is given, the local path defaults to the filename provided in the parameter <cSourceFileName>. If a file with the same path already exists, it is overwritten. Otherwise, a new file is created.

An optional code block which is evaluated while the file is downloaded from the FTP server. The code block can be used for monitoring or visualizing the progress of the file transfer. The code block is evaluated with the following parameters:

{|nRead, nTotal| ... }

The first parameter <nRead> is the number of bytes already transferred from the server. The second parameter <nTotal> indicates the total number of bytes to download.

.T. (true) if the download is successful, .F. (false) otherwise.

Downloads a remote file from the SFTP server and writes the content to a local file.

Unlike :get(), the data is read from the server and written to the file holding only one data chunk in memory at a time, thus optimizing memory footprint.

If the remote file does not exist, the operation fails. If a local file with the same name already exists, it is overwritten.

In case of an error condition, use :getLastError() and :getLastMessage() methods to obtain detailed error information.

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.

Method SFTPClient():getFile() Foundation