Downloads the content of the specified remote file or directory to the local directory.
This method only downloads the items in the specified directory if the
remotePath parameter does not end with a directory separator (e.g. '/').
To also create the directory in the destination, add a directory separator character at the end of
that parameter.
public FileSystemTransferStatistics Download(
string remotePath,
string localPath,
TransferOptions options
)
Public Function Download( _
ByVal remotePath As String, _
ByVal localPath As String, _
ByVal options As TransferOptions _
) As FileSystemTransferStatistics
public:
FileSystemTransferStatistics Download(
String^ remotePath,
String^ localPath,
TransferOptions^ options
);
Parameters
- remotePath
- The path and name of the remote directory where the files will be downloaded to the local folder.
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.
If this value ends with a directory separator character like '/' or '\', the containing directory will also be downloaded. For example, if "/folder/" is used, files and subdirectories of "folder" directory and itself will be downloaded; the destination directory will contain "folder" directory and its contents.
Attention: some servers may be case-sensitive!
- localPath
- The path of the local directory on the disk file system to receive files from the remote server.
- options
- The transfer options object which provides many settings to control the file transfer process.
Download files 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 containing files and folders to download.
@"C:\dest", // The local directory.
new TransferOptions()
);
// Download DOC files only.
ftp.Download(
"/data/*.doc", // The remote directory on the FTP server containing files and folders to download.
@"C:\dest", // The local directory.
new TransferOptions()
);
}
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", "C:\dest", New TransferOptions()) ' The local directory. - The remote directory on the FTP server containing files and folders to download.
' Download DOC files only.
ftp.Download("/data/*.doc", "C:\dest", New TransferOptions()) ' The local directory. - The remote directory on the FTP server containing files and folders to download.
End Using