Downloads the specified remote file or directory hierarchy on the server to the specified 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,
SearchCondition searchCondition
)
Public Function Download( _
ByVal remotePath As String, _
ByVal localPath As String, _
ByVal searchCondition As SearchCondition _
) As FileSystemTransferStatistics
public:
FileSystemTransferStatistics Download(
String^ remotePath,
String^ localPath,
SearchCondition^ searchCondition
);
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 is a combination of the masks, if found, in the localPath and the searchCondition parameters.
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 to receive files from the server.
- searchCondition
- The search conditions to match against the files, or a null reference to download all files and subdirectories. The final search condition is a combination of this parameter and the masks, if found, in the localPath parameter.
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", // The remote directory on the FTP server.
@"C:\dest", // The local directory to files and folders.
new NameSearchCondition("*.dat;*.txt") // Download files with DAT or TXT extensions
.AndSizeGreaterThan(10 * 1024) // with size > 10kb
);
// Download DAT and TXT files only.
ftp.Download(
"/data/*.dat;*.txt", // The remote directory on the FTP server.
@"C:\dest", // The local directory to files and folders.
(SearchCondition)null
);
}
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 NameSearchCondition("*.dat;*.txt")).AndSizeGreaterThan(10 * 1024)) ' with size > 10kb - Download files with DAT or TXT extensions - The local directory to files and folders. - The remote directory on the FTP server.
' Download DAT and TXT files only.
ftp.Download("/data/*.dat;*.txt", "C:\dest", CType(Nothing, SearchCondition)) ' The local directory to files and folders. - The remote directory on the FTP server.
End Using