C++

SFTP Read Directory Listing

See more SFTP Examples

Demonstrates how to download a directory listing and iterate over the files. C++

#include <CkSFtp.h>
#include <CkSFtpDir.h>
#include <CkSFtpFile.h>

void ChilkatSample(void)
    {
    bool success = false;

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

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

    CkSFtp sftp;

    // Set some timeouts, in milliseconds:
    sftp.put_ConnectTimeoutMs(5000);
    sftp.put_IdleTimeoutMs(10000);

    // Connect to the SSH server.  
    // The standard SSH port = 22
    // The hostname may be a hostname or IP address.
    const char *hostname = "www.my-sftp-server.com";
    int port = 22;
    success = sftp.Connect(hostname,port);
    if (success == false) {
        std::cout << sftp.lastErrorText() << "\r\n";
        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 == false) {
        std::cout << sftp.lastErrorText() << "\r\n";
        return;
    }

    // After authenticating, the SFTP subsystem must be initialized:
    success = sftp.InitializeSftp();
    if (success == false) {
        std::cout << sftp.lastErrorText() << "\r\n";
        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. 
    const char *handle = sftp.openDir(".");
    if (sftp.get_LastMethodSuccess() == false) {
        std::cout << sftp.lastErrorText() << "\r\n";
        return;
    }

    // Download the directory listing:

    CkSFtpDir dirListing;
    success = sftp.ReadDirListing(handle,dirListing);
    if (success == false) {
        std::cout << sftp.lastErrorText() << "\r\n";
        return;
    }

    // Close the handle for the directory listing.
    success = sftp.CloseHandle(handle);
    if (success == false) {
        std::cout << sftp.lastErrorText() << "\r\n";
        return;
    }

    // Iterate over the files.
    CkSFtpFile fileObj;
    int i = 0;
    int n = dirListing.get_NumFilesAndDirs();
    while (i < n) {

        success = dirListing.FileAt(i,fileObj);
        if (success == false) {
            std::cout << dirListing.lastErrorText() << "\r\n";
            return;
        }

        std::cout << fileObj.filename() << "\r\n";
        std::cout << fileObj.fileType() << "\r\n";
        std::cout << "Size in bytes: " << fileObj.get_Size32() << "\r\n";
        std::cout << "----" << "\r\n";

        i = i + 1;
    }

    std::cout << "Success." << "\r\n";
    }