Programming with Reflection

image\rwnprg32.gif FTPReceiveFile method

 

Syntax object.FTPReceiveFile LocalFile, RemoteFile, [TransferType], [IfFileExists], [Before], [Since], [Exclude]

 

Description

Transfers one or more files from the host to the PC using FTP (file transfer protocol). Use FTPStartServer to connect to the host server before using this method. Use FTPStopServer to disconnect from the host server after file transfer is complete. Click the Example link below to see a sample macro that uses these methods.

Arguments

LocalFile Argument type: String
Required
Specifies a local file. This string can be empty or can contain just drive and path information, in which case the host filename is used to generate a local filename. This string cannot contain wildcard characters.

RemoteFile Argument type: String
Required
Specifies a host file or files to be transferred. This string can contain wildcard characters (to transfer multiple files). The wildcard characters must be appropriate for the host system.

 Note: For connections to VMS hosts, fully qualified path names are not supported. For these hosts, use FTPSetCurrentHostDirectory to specify a server location.

TransferType Argument type: Enumeration
Optional
rcASCII

 Specifies ASCII file transfer. Reflection applies the ASCII File Translation options (as specified on the Translation tab in the File Transfer Setup dialog box) to the data in the file as it is transferred.

 rcBinary

 Specifies binary file transfer. Data in the file is not translated as it is transferred.

IfFileExists Argument type: Enumeration
Optional
Specifies what to do if the file already exists on the host. The default is rcCancel. The possible values are:

 rcAskUser

 Prompts the user to specify what should be done.

 rcCancel

 Stops the transfer.

 rcUpdate

 Performs the transfer only if the host file is newer than the PC file.

 rcDelete

 Deletes (overwrites) the existing file.

 rcAppend

 Appends the contents of the host file to the existing PC file.

 rcRename

 Renames the file being transferred. The existing file retains the original name. The last three characters of the file being transferred are changed to 001. If such a file already exists, the file's name is changed to 002, and so on up to 999.

 rcSkip

 Skips the file (the transfer does not take place, but no error results).

Before Argument Type: Date/Time
Optional
Specifies a date and time. Only host files created or modified before the specified date and time are transferred.

Since Argument Type: Date/Time
Optional
Specifies a date and time. Only host files created or modified after the specified date and time are transferred.

Exclude Argument Type: String
Optional
Specifies one or more files to be excluded from a wildcard transfer. The file names can include wildcards.

 

 

image\jump.gif Example

image\jump.gif Keyword Index

image\popup.gif Related Topics

image\popup.gif Reflection products that use this command