Xojo Plugin

SCP Download Files Matching a Pattern, such as *.txt

See more SCP Examples

Demonstrates how to SCP download files matching a pattern, such as *.txt. Xojo Plugin

Dim success As Boolean
success = False

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

Dim ssh As New Chilkat.Ssh

// Connect to an SSH server:
Dim hostname As String
hostname = "MY-SSH-SERVER-DOMAIN-OR-IP"
Dim port As Int32
port = 22

success = ssh.Connect(hostname,port)
If (success <> True) Then
    System.DebugLog(ssh.LastErrorText)
    Return
End If

// Wait a max of 5 seconds when reading responses..
ssh.IdleTimeoutMs = 5000

// Authenticate using login/password:
success = ssh.AuthenticatePw("MY-SSH-LOGIN","MY-SSH-PASSWORD")
If (success <> True) Then
    System.DebugLog(ssh.LastErrorText)
    Return
End If

// Once the SSH object is connected and authenticated, use it
// in the SCP object.
Dim scp As New Chilkat.Scp

success = scp.UseSsh(ssh)
If (success <> True) Then
    System.DebugLog(scp.LastErrorText)
    Return
End If

scp.HeartbeatMs = 200

// Set the SyncMustMatch property to "*.pem" to download only .pem files
scp.SyncMustMatch = "*.pem"

Dim remoteDir As String
remoteDir = "qa_syncA"
Dim localDir As String
localDir = "c:/aaworkarea/scp/qa_syncA"

// Download synchronization modes:
// mode=0: Download all files
// mode=1: Download all files that do not exist on the local filesystem.
// mode=2: Download newer or non-existant files.
// mode=3: Download only newer files.  
//         If a file does not already exist on the local filesystem, it is not downloaded from the server.
// mode=5: Download only missing files or files with size differences.
// mode=6: Same as mode 5, but also download newer files.
Dim mode As Int32
mode = 0

// Do not recurse the remote directory tree.  Only download files matching *.pem
// from the given remote directory.
Dim bRecurse As Boolean
bRecurse = False

success = scp.SyncTreeDownload(remoteDir,localDir,mode,bRecurse)
If (success <> True) Then
    System.DebugLog(scp.LastErrorText)
    Return
End If

System.DebugLog("SCP download matching success.")

// Disconnect
ssh.Disconnect