Discuss this help topic in SecureBlackbox Forum

TElSimpleFTPSClient.DownloadFile

TElSimpleFTPSClient     See also     


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


Downloads a file from the server.

Declaration

[C#/Java]
    void DownloadFile(string RemoteFileName, string LocalFileName);
    void DownloadFile(string RemoteFileName, string LocalFileName, TSBFileTransferMode Mode);
    void DownloadFile(string RemoteFileName, string LocalFileName, TSBFileTransferMode Mode, long RestartFrom);

[VB.NET]
    Sub DownloadFile(ByVal RemoteFileName As String, ByVal LocalFileName As String)
    Sub DownloadFile(ByVal RemoteFileName As String, ByVal LocalFileName As String, ByVal Mode As TSBFileTransferMode)
    Sub DownloadFile(ByVal RemoteFileName As String, ByVal LocalFileName As String, ByVal Mode As TSBFileTransferMode, ByVal RestartFrom As Long)

[Pascal]
    procedure DownloadFile(RemoteFileName, LocalFileName : string);
    procedure DownloadFile(RemoteFileName, LocalFileName : string; Mode : TSBFileTransferMode);
    procedure DownloadFile(RemoteFileName, LocalFileName : string; Mode : TSBFileTransferMode; RestartFrom : Int64);

[C++]
    void DownloadFile(const std::string &RemoteFileName, const std::string &LocalFileName);
    void DownloadFile(const std::string &RemoteFileName, const std::string &LocalFileName, TSBFileTransferMode Mode);
    void DownloadFile(const std::string &RemoteFileName, const std::string &LocalFileName, TSBFileTransferMode Mode, int64_t RestartFrom);

[PHP]
    void DownloadFile(string $RemoteFileName, string $LocalFileName)
    void DownloadFile(string $RemoteFileName, string $LocalFileName, integer $Mode)
    void DownloadFile(string $RemoteFileName, string $LocalFileName, integer $Mode, integer $RestartFrom)

Parameters

  • RemoteFileName - the path to the file to be downloaded
  • LocalFileName - local path for the downloaded file
  • Mode - specifies what to do if the file with the same name already exists
  • RestartFrom - can be used to resume broken transfer operation.When RestartFrom is set to non-zero positive value, the file being transferred is read starting from RestartFrom position and is written also starting from RestartFrom position.

Values


Description

    Use this method to download a file or its part from the server and store it in the file on the disk (or in virtual file system, if the appropriate file system adapter is used). RemoteFileName can include path to the file or just the file name (in the latter case the file is taken from the current directory).

See also:     About file system adapters     DownloadFiles     DownloadStream     Receive     UploadFile     FileSystemAdapter    

Discuss this help topic in SecureBlackbox Forum