B4X

Download a File from an FTP Server

Demonstrates the Chilkat Ftp2.GetFile method, which downloads a remote file to a local path. The first argument is the remote file path and the second is the local file path. The local parent directory must already exist.

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: This is the everyday download: Chilkat opens a data connection, transfers the file, and closes it. It does not create missing local directories, so make sure the destination folder exists first. Whether the bytes are transferred verbatim or with line-ending translation depends on the transfer type. Chilkat defaults to binary, which is the recommended choice for essentially every file — text included — so no call is needed to use it (SetTypeBinary sets it explicitly when required, such as after a prior SetTypeAscii). The SetTypeAscii alternative applies CRLF line-ending translation, a legacy behavior that is rarely wanted and that corrupts binary files.

Chilkat B4X Downloads

Download Chilkat for B4X

B4X

Dim success As Boolean = False

'  Demonstrates the Ftp2.GetFile method, which downloads a remote file to a local path.  The 1st
'  argument is the remote file path and the 2nd is the local file path.

Dim ftp As ChilkatFtp2
ftp.Initialize("ftp")

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
    Log(ftp.LastErrorText)
    Return
End If


'  Download a file.  The local parent directory must already exist; Chilkat does not create it.
success = ftp.GetFile("public_html/report.pdf", "qa_output/report.pdf")
If success = False Then
    Log(ftp.LastErrorText)
    Return
End If

Log("Downloaded.")

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