FTPDownload Method

Action2 Example

 

Encapsulates the AutoMate™ action in the “FTP” group, “FTP Download.” The method attempts to download the specified file from the FTP server previously connected to using the FTPLogin method.

 

Declaration

function FTPDownload (varFTPSource As Variant,

varFTPDest As Variant,

intTransType As Integer,

intIncludeSubDirs As Integer) As Integer

 

Parameters

varFTPSource

 The full path of the file on the FTP server to be downloaded.

varFTPDest

 The full path on the local machine of where the file should be downloaded to.

 

intTransType

 The transfer type AutoMate™ should use to download the file:

  

Value

Meaning

1

Default (Auto-detect)

2

ASCII/Text

3

Binary

 

intIncludeSubDirs

 If set to “0”, the download command applies to only the current directory. If set to “1”, the download command will go through all subdirectories as well.

 

Description

The FTPDownload method will attempt to download the file specified by varFTPSource to the local machine.

 

A connection to the FTP server must have been previously established by a successful called to FTPLogin.

 

 

NOTE: The Action2 FTP methods (with the exception of FTPQuickSend and FTPQuickRetrieve) may not function properly in the AutoMate™ BASIC IDE. To more accurately use these functions, run the script from within an AutoMate™ task using the “Run a BASIC Script” action.