Downloads the content of the specified remote directory to the local directory.
public FileSystemTransferStatistics Download(
string remotePath,
bool includeBaseDirectory,
string localPath,
bool recursive,
FileOverwriteMode fileExistsAction,
SymlinksResolveAction symlinksResolveAction
)
Public Function Download( _
ByVal remotePath As String, _
ByVal includeBaseDirectory As Boolean, _
ByVal localPath As String, _
ByVal recursive As Boolean, _
ByVal fileExistsAction As FileOverwriteMode, _
ByVal symlinksResolveAction As SymlinksResolveAction _
) As FileSystemTransferStatistics
public:
FileSystemTransferStatistics Download(
String^ remotePath,
bool includeBaseDirectory,
String^ localPath,
bool recursive,
FileOverwriteMode fileExistsAction,
SymlinksResolveAction symlinksResolveAction
);
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.
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, "/ZipDir", true)
- 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". - localPath
- The path of the local directory to receive files from the server.
- recursive
- A boolean value indicating whether to includes the source directory and all its subdirectories in the transfer operation.
- fileExistsAction
- Specifies the action taken on existing files.
- symlinksResolveAction
- Specifies the action taken on symlinks.
Download files from the local disk to the FTP server.
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/*.txt", // The remote directory on the FTP server. TXT files will be downloaded.
true, // "data" directory will be created on the local dir. Files and subdirectories in "/data" will be copied to "c:\dest\data" dir.
@"C:\dest", // The local directory containing files and folders to download.
true, // Download recursively
FileOverwriteMode.Overwrite, // Overwrite all existing files.
SymlinksResolveAction.Skip // If a symlink found, skip it.
);
}
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/*.txt", True, "C:\dest", True, FileOverwriteMode.Overwrite, SymlinksResolveAction.Skip) ' If a symlink found, skip it. - Overwrite all existing files. - Download recursively - The local directory containing files and folders to download. - "data" directory will be created on the local dir. Files and subdirectories in "/data" will be copied to "c:\dest\data" dir. - The remote directory on the FTP server. TXT files will be downloaded.
End Using