TElSimpleFTPSClient.DownloadFile method

TElSimpleFTPSClient.DownloadFile

Downloads a file from the server.

Declaration

[C#]
    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)

[Java]
    void downloadFile(String RemoteFileName, String LocalFileName);
    void downloadFile(String RemoteFileName, String LocalFileName, TSBFileTransferMode Mode, long RestartFrom);
    void downloadFile(String RemoteFileName, String LocalFileName, TSBFileTransferMode Mode);

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

[.NET] [C++]	[Pascal]	Description
ftmOverwrite = 0	ftmOverwrite	The file will be overwritten
ftmSkip = 1	ftmSkip	The file will be skipped if the file with the same name exists
ftmAppendToEnd = 2	ftmAppend	All data from the source file isappended to the end of the destination file (if itexists). This mode is useful, for example, for updatingthe remote log file.
ftmResume = 3	ftmResume	Resumes the transfer of the file by transferring the data from the source file (starting from position specified in RestartFrom and up to the end) to the destination file (the data is written to position specified in RestartFrom ). This mode is used to resume the broken upload or download. In Resume mode the component compares the sizes of source and destination files (streams). If the size of the destination is smaller than the size of the source, the transfer is restarted from the position equal to the destination size (resuming the broken transfer). Resume mode doesn't compare file times, so your application should only use this mode if it (or the user) knows that the destination file is an incompletely transferred source file, and not, e.g., an older version of the same file.
ftmOverwriteIfDiffSize = 4	ftmOverwriteIfDiffSize	Defines a conditional overwrite onlywhen the file size is different. NOTE: file size isdetermined using the chosen transfer type (ascii/binary).In ASCII mode the file size can be determinedincorrectly, and you should not use conditionaloverwrite then.
ftmSaveWithNewName = 5	ftmSaveWithNewName	When a file has been transferred, and another file with the same name already exists, the new file will be saved with a new name.For each such file an OnFileNameChangeNeeded event is fired.
ftmRenameExistingTarget = 6	ftmRenameExistingTarget	In contrary to the ftmSaveWithNewName option, the existing file will be renamed, while the new file is saved under its original name.For each such file an OnFileNameChangeNeeded event is fired.

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).

Discuss this help topic in SecureBlackbox Forum