Download(String, Boolean, IEnumerable, String, TransferOptions, Int32, Boolean) Method

public FileSystemTransferStatistics Download(
   string remotePath, 
   bool includeBaseDirectory, 
   IEnumerable remoteFilesToTransfer, 
   string localPath, 
   TransferOptions options, 
   int threads, 
   bool waitForThreads
)

Public Function Download( _
   ByVal remotePath As String,  _
   ByVal includeBaseDirectory As Boolean,  _
   ByVal remoteFilesToTransfer As IEnumerable,  _
   ByVal localPath As String,  _
   ByVal options As TransferOptions,  _
   ByVal threads As Integer,  _
   ByVal waitForThreads As Boolean _
) As FileSystemTransferStatistics

public:
  FileSystemTransferStatistics Download(
   String^ remotePath, 
   bool includeBaseDirectory, 
   IEnumerable^ remoteFilesToTransfer, 
   String^ localPath, 
   TransferOptions^ options, 
   int threads, 
   bool waitForThreads
);

Parameters

remotePath

The path and name of the remote directory where the files will be downloaded to the local folder. When the parameter remoteFilesToTransfer is a null reference, this parameter can include filtering masks to limit the files that are downloaded. For example, if ""(empty string) is specified, the entire contents of the current folder will be downloaded. If "*.txt" is used, all the files in the current folder that have the .TXT extension will be downloaded. If "/mydir/*.dat;*.cs,*.vb" is used (masks are delimited by ',', ';', and '|' characters), files with the DAT, CS, or VB extension in "/mydir" will be downloaded. If no masks specified, the whole content of the remote directory should be downloaded. The final search condition depends on the SearchCondition and SearchConditionCombinedWithMasksInSourcePath settings of the options parameter. Attention: some servers may be case-sensitive!

includeBaseDirectory

Indicates whether the containing directory should also be created in the destination directory. For example: Download("/MyDir/*.txt", true, null, "/ZipDir" ...) - if this parameter is true, "MyDir" is created in "ZipDir" and all files and dirs within "MyDir" are copied to "ZipDir/MyDir"; otherwise false, "MyDir" is not created in "ZipDir", only files and subdirectories within "MyDir" are copied to "ZipDir".

remoteFilesToTransfer

The list of files and directories to download, or a null reference to transfer files in the remotePath that match the search condition specified in the options parameter. This list can contain String and FileInfoBase objects. (e.g. Download("", false, new string[] {"file1", "file2", "dir1" }...) or Download(new object[] {"file1", fileInfo1, fileInfo2 }...))

localPath

The path of the local directory to receive files from the server.

options

The transfer options object which provides many settings to control the file transfer process.

threads

The number of threads used for the simultaneous file transfer.

waitForThreads

A boolean value indicating whether to wait for the completion of all threads. If this parameter is true, this method blocks the caller process's execution until all threads have completed; otherwise, this method immediately returns the control to the caller process.

Return Value

Use 50 threads to download files simultaneously from the local disk.

using ComponentPro;
using ComponentPro.IO;
using ComponentPro.Net;

...

using (Ftp ftp = new Ftp())
{
    // Connect to the FTP server. 
    ftp.Connect("localhost");

    // Authenticate. 
    ftp.Authenticate("test", "test");

    ftp.Download(
        "/data", // The remote directory on the FTP server. 
        false, // The base directory is not include - only files and subdirectories in "c:\data" will be copied. 
        null,
        "C:\\data", // The local directory. 
        new TransferOptions(),
        50, // Use 50 threads 
        true // Wait until all the threads complete. 
        );

    // Download TXT and DAT files only 
    ftp.Download(
        "/data/*.txt;*.dat", // The remote directory on the FTP server. 
        false, // The base directory is not include - only files and subdirectories in "c:\data" will be copied. 
        null,
        "C:\\data", // The local directory. 
        new TransferOptions(),
        50, // Use 50 threads 
        true // Wait until all the threads complete. 
        );


    string[] filesAndFoldersToDownload = new string[]
                                           {
                                               "content1", // folder 
                                               "content2", // folder 
                                               "dir\\file1", // file 
                                               "file2"       // file                                              
                                           };

    ftp.Download(
        "/data", // The remote directory on the FTP server. 
        false, // The base directory is not include 
        filesAndFoldersToDownload, // only files and folders in this list in "/data" folder will be downloaded. 
        "C:\\data", // The local directory. 
        new TransferOptions(),
        50, // Use 50 threads 
        true // Wait until all the threads complete. 
        );
}

Imports ComponentPro
Imports ComponentPro.IO
Imports ComponentPro.Net

...

Using ftp As New Ftp()
    ' Connect to the FTP server. 
    ftp.Connect("localhost")

    ' Authenticate. 
    ftp.Authenticate("test", "test")

    ftp.Download("/data", False, Nothing, "C:\data", New TransferOptions(), 50, True) ' Wait until all the threads complete. -  Use 50 threads -  The local directory. -  The base directory is not include - only files and subdirectories in "c:\data" will be copied. -  The remote directory on the FTP server. 
 
    ' Download TXT and DAT files only 
    ftp.Download("/data/*.txt;*.dat", False, Nothing, "C:\data", New TransferOptions(), 50, True) ' Wait until all the threads complete. -  Use 50 threads -  The local directory. -  The base directory is not include - only files and subdirectories in "c:\data" will be copied. -  The remote directory on the FTP server.


    Dim filesAndFoldersToDownload() As String = { "content1", "content2", "dir\file1", "file2" }

    ftp.Download("/data", False, filesAndFoldersToDownload, "C:\data", New TransferOptions(), 50, True) ' Wait until all the threads complete. -  Use 50 threads -  The local directory. -  only files and folders in this list in "/data" folder will be downloaded. -  The base directory is not include -  The remote directory on the FTP server. 
End Using

Reference