Xojo Plugin

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 Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

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

Dim ftp As New Chilkat.Ftp2

ftp.Hostname = "ftp.example.com"
ftp.Username = "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.
ftp.Password = "myPassword"

success = ftp.Connect()
If (success = False) Then
    System.DebugLog(ftp.LastErrorText)
    Return
End If

//  Download a UTF-8 text file.  A byte-order mark for the selected encoding is recognized and
//  omitted from the returned text.
Dim fileText As String
fileText = ftp.GetRemoteFileTextC("public_html/readme.txt","utf-8")
If (ftp.LastMethodSuccess = False) Then
    System.DebugLog(ftp.LastErrorText)
    Return
End If

System.DebugLog(fileText)

success = ftp.Disconnect()
If (success = False) Then
    System.DebugLog(ftp.LastErrorText)
    Return
End If