Tcl

Download an FTP File to a Stream

Demonstrates the Chilkat Ftp2.GetFileToStream method, which downloads a remote file and writes its bytes to a Stream. The first argument is the remote file path and the second is the Stream, which must have a destination sink configured beforehand.

Note: The local paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

Background: Streaming to a Stream object decouples the download from where the bytes ultimately go — a file (as here, via SinkFile), or a pipe feeding another component such as a decompressor or a hashing routine — and processes the data as it arrives rather than buffering the whole file. That keeps memory flat for large downloads and lets you chain the transfer into a processing pipeline.

Chilkat Tcl Downloads

Download Chilkat for Tcl

Tcl


load ./chilkat.dll

set success 0

#  Demonstrates the Ftp2.GetFileToStream method, which downloads a remote file and writes its
#  bytes to a Stream.  The 1st argument is the remote file path and the 2nd is the Stream.

set ftp [new_CkFtp2]

CkFtp2_put_Hostname $ftp "ftp.example.com"
CkFtp2_put_Username $ftp "myFtpLogin"

#  Normally you would not hard-code the password in source.  You should instead obtain it
#  from an interactive prompt, environment variable, or a secrets vault.
CkFtp2_put_Password $ftp "myPassword"

set success [CkFtp2_Connect $ftp]
if {$success == 0} then {
    puts [CkFtp2_lastErrorText $ftp]
    delete_CkFtp2 $ftp
    exit
}

#  Configure the stream's destination sink before downloading.  Here the stream writes to a
#  local file.
set fileStream [new_CkStream]

CkStream_put_SinkFile $fileStream "qa_output/report.pdf"

set success [CkFtp2_GetFileToStream $ftp "public_html/report.pdf" $fileStream]
if {$success == 0} then {
    puts [CkFtp2_lastErrorText $ftp]
    delete_CkFtp2 $ftp
    delete_CkStream $fileStream
    exit
}

puts "Downloaded to stream."

set success [CkFtp2_Disconnect $ftp]
if {$success == 0} then {
    puts [CkFtp2_lastErrorText $ftp]
    delete_CkFtp2 $ftp
    delete_CkStream $fileStream
    exit
}


delete_CkFtp2 $ftp
delete_CkStream $fileStream