SFTP Download Files Matching a Pattern

Demonstrates how to download the files in a remote SFTP directory matching a file pattern. The example opens a directory, iterates over the files, and downloads each file matching a file pattern, such as "*.xml".

Download Chilkat .NET for 4.0 Framework

Download Chilkat .NET for 64-bit 4.0 Framework (x64)

Download Chilkat .NET for 2.0 / 3.5 Framework

Download Chilkat .NET for 64-bit 2.0 / 3.5 Framework (x64)

Download Chilkat .NET for 1.0 / 1.1 Framework

//  Important: It is helpful to send the contents of the
//  sftp.LastErrorText property when requesting support.

Chilkat.SFtp sftp = new Chilkat.SFtp();

//  Any string automatically begins a fully-functional 30-day trial.
bool success;
success = sftp.UnlockComponent("Anything for 30-day trial");
if (success != true) {
    MessageBox.Show(sftp.LastErrorText);
    return;
}

//  Set some timeouts, in milliseconds:
sftp.ConnectTimeoutMs = 5000;
sftp.IdleTimeoutMs = 10000;

//  Connect to the SSH server.
//  The standard SSH port = 22
//  The hostname may be a hostname or IP address.
int port;
string hostname;
hostname = "www.my-sftp-server.com";
port = 22;
success = sftp.Connect(hostname,port);
if (success != true) {
    MessageBox.Show(sftp.LastErrorText);
    return;
}

//  Authenticate with the SSH server.  Chilkat SFTP supports
//  both password-based authenication as well as public-key
//  authentication.  This example uses password authenication.
success = sftp.AuthenticatePw("myLogin","myPassword");
if (success != true) {
    MessageBox.Show(sftp.LastErrorText);
    return;
}

//  After authenticating, the SFTP subsystem must be initialized:
success = sftp.InitializeSftp();
if (success != true) {
    MessageBox.Show(sftp.LastErrorText);
    return;
}

//  Open a directory on the server...
//  Paths starting with a slash are "absolute", and are relative
//  to the root of the file system. Names starting with any other
//  character are relative to the user's default directory (home directory).
//  A path component of ".." refers to the parent directory,
//  and "." refers to the current directory.
string handle;
string dirPath;
dirPath = "abc123";
handle = sftp.OpenDir(dirPath);
if (handle == null ) {
    MessageBox.Show(sftp.LastErrorText);
    return;
}

//  Download the directory listing:
Chilkat.SFtpDir dirListing = null;
dirListing = sftp.ReadDir(handle);
if (dirListing == null ) {
    MessageBox.Show(sftp.LastErrorText);
    return;
}

//  Iterate over the files.
int i;
int n;
n = dirListing.NumFilesAndDirs;
if (n == 0) {
    textBox1.Text += "No entries found in this directory." + "\r\n";
}
else {
    for (i = 0; i <= n - 1; i++) {
        Chilkat.SFtpFile fileObj = null;
        fileObj = dirListing.GetFileObject(i);

        textBox1.Text += fileObj.Filename + "\r\n";

        //  Does this filename match the desired pattern?
        //  Write code here to determine if it's a match or not.

        //  Assuming it's a match, you would download the file
        //  like this:
        string remoteFilePath;
        remoteFilePath = dirPath + "/";
        remoteFilePath = remoteFilePath + fileObj.Filename;
        string localFilePath;
        localFilePath = fileObj.Filename;
        success = sftp.DownloadFileByName(remoteFilePath,localFilePath);
        if (success != true) {
            MessageBox.Show(sftp.LastErrorText);
            return;
        }

    }

}

//  Close the directory
success = sftp.CloseHandle(handle);
if (success != true) {
    MessageBox.Show(sftp.LastErrorText);
    return;
}

MessageBox.Show("Success.");