Tcl

Download an FTP File as Text with a Charset

Demonstrates the Chilkat Ftp2.GetRemoteFileTextC method, which downloads a remote file, decodes the bytes using a named charset, and returns the text. The first argument is the remote filename and the second is the charset. A byte-order mark for the selected encoding is recognized and omitted.

Background: This is the encoding-aware way to read a remote text file: you name the charset (utf-8, iso-8859-1, and so on) so multibyte and accented characters decode correctly, and a leading BOM is stripped automatically. Prefer it over GetRemoteFileTextData whenever the file's encoding is known, which is almost always.

Chilkat Tcl Downloads

Download Chilkat for Tcl

Tcl


load ./chilkat.dll

set success 0

#  Demonstrates the Ftp2.GetRemoteFileTextC method, which downloads a remote file, decodes the
#  bytes using a named charset, and returns the text.  The 1st argument is the remote filename
#  and the 2nd is the charset.

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
}

#  Download a UTF-8 text file.  A byte-order mark for the selected encoding is recognized and
#  omitted from the returned text.
set fileText [CkFtp2_getRemoteFileTextC $ftp "public_html/readme.txt" "utf-8"]
if {[CkFtp2_get_LastMethodSuccess $ftp] == 0} then {
    puts [CkFtp2_lastErrorText $ftp]
    delete_CkFtp2 $ftp
    exit
}

puts "$fileText"

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


delete_CkFtp2 $ftp