Discuss this help topic in SecureBlackbox Forum

TElSimpleFTPSClient.DownloadStream

TElSimpleFTPSClient     See also     


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


Downloads the remote file to the stream.

Declaration

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

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


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

See also:     FileSystemAdapter     DownloadFile     DownloadFiles     Receive     UploadStream    

Discuss this help topic in SecureBlackbox Forum