TIpClientFtp() > File methods

oTIpClientFtp:downloadFile()

Downloads a file.

Syntax

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

Arguments

<cLocalFile>

This is a character string holding the name of the file on the local station where downloaded data is written to. It must include path and file extension. If the path is omitted from <cLocalFile>, the file is created in the current directory.

<cRemoteFile>

This is an optional character string holding the name of the file on the FTP server. It must be specified without path information. If omitted, the file name from <cLocalFile> is used.

Description

Method :downloadFile() transfers a file from the FTP server to the local station and returns a logical value indicating success of the operation. The file must be located in the current directory of the FTP server. Use method :mget() to download multiple files with one method call.