ReceiveFTPFile

ReceiveFTPFile()

Syntax

Result = ReceiveFTPFile(#Ftp, RemoteFilename$, Filename$ [, Asynchronous])

Description

Receives a file from a FTP server.

Parameters

#Ftp The connection to use.

RemoteFilename$ The name of the file to download. It has to be in the current ftp directory (see GetFTPDirectory() and SetFTPDirectory()).

Filename$ The location to save the file on the local system. If the filename does not include a full path, it is interpreted relative to the current directory. If the file exists, it will be overwritten.

Asynchronous (optional) If set to a #True, the transfer will be made in the background. The default is to block the program until the file has been received. The progress of an asynchronous transfer can be received with the FTPProgress() command and it can be aborted using the AbortFTPFile() command.

Return value

Returns nonzero if the file was downloaded correctly, or the asynchronous transfer was initialized correctly. On failure, the return-value is zero.

Remarks

Only one file can be downloaded or uploaded (see SendFTPFile()) in the background at once.

See Also

SendFTPFile(), SetFTPDirectory(), GetFTPDirectory(), FTPProgress(), AbortFTPFile()

Supported OS

All

<- OpenFTP() - Ftp Index - RenameFTPFile() ->

#Ftp	The connection to use.
RemoteFilename$	The name of the file to download. It has to be in the current ftp directory (see GetFTPDirectory() and SetFTPDirectory()).
Filename$	The location to save the file on the local system. If the filename does not include a full path, it is interpreted relative to the current directory. If the file exists, it will be overwritten.
Asynchronous (optional)	If set to a #True, the transfer will be made in the background. The default is to block the program until the file has been received. The progress of an asynchronous transfer can be received with the FTPProgress() command and it can be aborted using the AbortFTPFile() command.