(Xojo Plugin) Co:Z SFTP Binary File Download (from z/OS IBM Mainframe)

Demonstrates how to download a binary file, such as a .zip, from a Co:Z SFTP server on a z/OS IBM Mainframe.

Note: This requires Chilkat v9.5.0.76 or greater.

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Dim sftp As New Chilkat.SFtp

// Connect to the SSH server.  
Dim hostname As String
hostname = "sftp.example.com"
Dim port As Int32
port = 22
Dim success As Boolean
success = sftp.Connect(hostname,port)
If (success <> True) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

success = sftp.AuthenticatePw("myLogin","myPassword")
If (success <> True) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

success = sftp.InitializeSftp()
If (success <> True) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

// To download a binary file from the Co:Z SFTP server, 
// we must switch to binary mode in the following unconventional way.
// We pretend to fetch a directory listing for "/+mode=binary"
// This has the effect of putting the server in binary mode for transfers.
Dim handle As String
handle = sftp.OpenDir("/+mode=binary")
If (sftp.LastMethodSuccess <> True) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

// Download the "directory listing" (but it's not actually a directory listing, and we'll just discard it.)
Dim dirListing As Chilkat.SFtpDir
dirListing = sftp.ReadDir(handle)
If (sftp.LastMethodSuccess <> True) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

// Close the directory handle:
success = sftp.CloseHandle(handle)
If (success <> True) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

// Download the binary file:
Dim localFilePath As String
localFilePath = "c:/temp/test.zip"
Dim remoteFilePath As String
remoteFilePath = "test.zip"
success = sftp.DownloadFileByName(remoteFilePath,localFilePath)
If (success <> True) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

System.DebugLog("Success.")