TElSimpleFTPSClient.DownloadStream method

TElSimpleFTPSClient.DownloadStream

Downloads the remote file to the stream.

Declaration

[C#]
void DownloadStream(string RemoteFileName, System.IO.Stream LocalStream, TSBFileTransferMode Mode, long RestartFrom);

[VB.NET]
Sub DownloadStream(ByVal RemoteFileName As String, ByVal LocalStream As System.IO.Stream, ByVal Mode As TSBFileTransferMode, ByVal RestartFrom As Long)

[Pascal]
procedure DownloadStream(RemoteFileName : string; LocalStream : TStream; Mode : TSBFileTransferMode);
procedure DownloadStream(RemoteFileName : string; LocalStream : TStream; Mode : TSBFileTransferMode; RestartFrom : Int64);

[C++]
void DownloadStream(const std::string &RemoteFileName, TStream &LocalStream, TSBFileTransferMode Mode, int64_t RestartFrom);
void DownloadStream(const std::string &RemoteFileName, TStream *LocalStream, TSBFileTransferMode Mode, int64_t RestartFrom);

[PHP]
void DownloadStream(string $RemoteFileName, TStream $LocalStream, integer $Mode, integer $RestartFrom)

[Java]
void downloadStream(String RemoteFileName, TElStream LocalStream, TSBFileTransferMode Mode, long RestartFrom);

Parameters

RemoteFileName - remote path to the downloaded file
LocalStream - local stream to store the file to
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 and save it to the instance of a descendant of Stream / TStream class. 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