Discuss this help topic in SecureBlackbox Forum

TElSimpleFTPSClient.DownloadFiles

TElSimpleFTPSClient     See also     


Filter: C#/Java  VB.NET  Pascal  C++  PHP  


Downloads files according to the given rule from the server.

Declaration

[C#/Java]
    void DownloadFiles(string RemotePath, string RemoteMask, string LocalPath, TSBFileTransferMode Mode, bool CaseSensitive, TSBCaseConversion CaseConversion, bool Recursive);
    void DownloadFiles(string RemotePath, string RemoteMask, string LocalPath, TSBFileTransferMode Mode, TSBFileCopyMode CopyMode, bool CaseSensitive, TSBCaseConversion CaseConversion, bool Recursive);

[VB.NET]
    Sub DownloadFiles(ByVal RemotePath As String, ByVal RemoteMask As String, ByVal LocalPath As String, ByVal Mode As TSBFileTransferMode, ByVal CaseSensitive As Boolean, ByVal CaseConversion As TSBCaseConversion, ByVal Recursive As Boolean)
    Sub DownloadFiles(ByVal RemotePath As String, ByVal RemoteMask As String, ByVal LocalPath As String, ByVal Mode As TSBFileTransferMode, ByVal CopyMode As TSBFileCopyMode, ByVal CaseSensitive As Boolean, ByVal CaseConversion As TSBCaseConversion, ByVal Recursive As Boolean)

[Pascal]
    procedure DownloadFiles(const RemotePath, RemoteMask: string; const LocalPath: string; Mode: TSBFileTransferMode; CaseSensitive: boolean; CaseConversion: TSBCaseConversion; Recursive: boolean);
    procedure DownloadFiles(const RemotePath, RemoteMask: string; const LocalPath: string; Mode: TSBFileTransferMode; CopyMode: TSBFileCopyMode; CaseSensitive: boolean; CaseConversion: TSBCaseConversion; Recursive: boolean);

[C++]
    void DownloadFiles(const std::string &RemotePath, const std::string &RemoteMask, const std::string &LocalPath, TSBFileTransferMode Mode, bool CaseSensitive, TSBCaseConversion CaseConversion, bool Recursive);
    void DownloadFiles(const std::string &RemotePath, const std::string &RemoteMask, const std::string &LocalPath, TSBFileTransferMode Mode, TSBFileCopyMode CopyMode, bool CaseSensitive, TSBCaseConversion CaseConversion, bool Recursive);

[PHP]
    void DownloadFiles(string $RemotePath, string $RemoteMask, string $LocalPath, integer $Mode, bool $CaseSensitive, integer $CaseConversion, bool $Recursive)
    void DownloadFiles(string $RemotePath, string $RemoteMask, string $LocalPath, integer $Mode, integer $CopyMode, bool $CaseSensitive, integer $CaseConversion, bool $Recursive)

Parameters

  • RemotePath - the path to remote files to be downloaded.
  • RemoteMask - the mask to match the remote files to.
  • LocalPath - local path to store downloaded files.
  • Mode - specifies what to do if the file with the same name already exists.
  • CopyMode - specifies file copy mode.
  • CaseSensitive - specifies whether filename matching [to mask] is case-sensitive.
  • CaseConversion - specifies whether case conversion must be applied to file names as they are downloaded.
  • Recursive - specifies if the subdirectories should also be scanned for matching files.

TSBFileTransferMode values:


TSBFileCopyMode values:


TSBCaseConversion values:


Description

    Use this method to download one or more files from the server to the local disk (or in virtual file system, if the appropriate file system adapter is used). Files are chosen by mask which can be a simple mask, set of masks or regular expression (read more about masks).

Discuss this help topic in SecureBlackbox Forum