C

SFTP Read Directory Listing

See more SFTP Examples

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

#include <C_CkSFtp.h>
#include <C_CkSFtpDir.h>
#include <C_CkSFtpFile.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkSFtp sftp;
    const char *hostname;
    int port;
    const char *handle;
    HCkSFtpDir dirListing;
    HCkSFtpFile fileObj;
    int i;
    int n;

    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.

    sftp = CkSFtp_Create();

    // Set some timeouts, in milliseconds:
    CkSFtp_putConnectTimeoutMs(sftp,5000);
    CkSFtp_putIdleTimeoutMs(sftp,10000);

    // Connect to the SSH server.  
    // The standard SSH port = 22
    // The hostname may be a hostname or IP address.
    hostname = "www.my-sftp-server.com";
    port = 22;
    success = CkSFtp_Connect(sftp,hostname,port);
    if (success == FALSE) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        CkSFtp_Dispose(sftp);
        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 = CkSFtp_AuthenticatePw(sftp,"myLogin","myPassword");
    if (success == FALSE) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        CkSFtp_Dispose(sftp);
        return;
    }

    // After authenticating, the SFTP subsystem must be initialized:
    success = CkSFtp_InitializeSftp(sftp);
    if (success == FALSE) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        CkSFtp_Dispose(sftp);
        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. 
    handle = CkSFtp_openDir(sftp,".");
    if (CkSFtp_getLastMethodSuccess(sftp) == FALSE) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        CkSFtp_Dispose(sftp);
        return;
    }

    // Download the directory listing:

    dirListing = CkSFtpDir_Create();
    success = CkSFtp_ReadDirListing(sftp,handle,dirListing);
    if (success == FALSE) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        CkSFtp_Dispose(sftp);
        CkSFtpDir_Dispose(dirListing);
        return;
    }

    // Close the handle for the directory listing.
    success = CkSFtp_CloseHandle(sftp,handle);
    if (success == FALSE) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        CkSFtp_Dispose(sftp);
        CkSFtpDir_Dispose(dirListing);
        return;
    }

    // Iterate over the files.
    fileObj = CkSFtpFile_Create();
    i = 0;
    n = CkSFtpDir_getNumFilesAndDirs(dirListing);
    while (i < n) {

        success = CkSFtpDir_FileAt(dirListing,i,fileObj);
        if (success == FALSE) {
            printf("%s\n",CkSFtpDir_lastErrorText(dirListing));
            CkSFtp_Dispose(sftp);
            CkSFtpDir_Dispose(dirListing);
            CkSFtpFile_Dispose(fileObj);
            return;
        }

        printf("%s\n",CkSFtpFile_filename(fileObj));
        printf("%s\n",CkSFtpFile_fileType(fileObj));
        printf("Size in bytes: %d\n",CkSFtpFile_getSize32(fileObj));
        printf("----\n");

        i = i + 1;
    }

    printf("Success.\n");


    CkSFtp_Dispose(sftp);
    CkSFtpDir_Dispose(dirListing);
    CkSFtpFile_Dispose(fileObj);

    }