SFTP Read Text File

Demonstrates how to open a text file on the SSH server and read text.

Downloads:

MS Windows Visual C/C++ Libraries

Linux/CentOS C/C++ Libraries

MAC OS X C/C++ Libraries

Solaris C/C++ Libraries

C++ Builder Libraries

#include <C_CkSFtp.h>

void ChilkatSample(void)
    {
    HCkSFtp sftp;
    BOOL success;
    long port;
    const char * hostname;
    const char * handle;
    const char * sText;

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

    sftp = CkSFtp_Create();

    //  Any string automatically begins a fully-functional 30-day trial.

    success = CkSFtp_UnlockComponent(sftp,"Anything for 30-day trial");
    if (success != TRUE) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        return;
    }

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

    //  Connect to the SSH server.
    //  The standard SSH port = 22
    //  The hostname may be a hostname or IP address.

    hostname = "www.my-ssh-server.com";
    port = 22;
    success = CkSFtp_Connect(sftp,hostname,port);
    if (success != TRUE) {
        printf("%s\n",CkSFtp_lastErrorText(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 != TRUE) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        return;
    }

    //  After authenticating, the SFTP subsystem must be initialized:
    success = CkSFtp_InitializeSftp(sftp);
    if (success != TRUE) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        return;
    }

    //  Open a file for reading.

    handle = CkSFtp_openFile(sftp,"myTest.txt","readOnly","openExisting");
    if (handle == 0 ) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        return;
    }

    //  Assume the file we are reading contains the following text:
    //  abcdefghijklmnopqrstuvwxyz1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ
    //  (in ANSI format -- i.e. one byte per char).

    //  Read 26 bytes:

    sText = CkSFtp_readFileText(sftp,handle,26,"ansi");
    if (success != TRUE) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        return;
    }

    //  Should print "abcdefghijklmnopqrstuvwxyz"
    printf("%s\n",sText);

    //  Read the next 10 bytes.
    sText = CkSFtp_readFileText(sftp,handle,10,"ansi");
    if (success != TRUE) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        return;
    }

    //  Should print "1234567890"
    printf("%s\n",sText);

    //  Read the next 26 bytes.
    sText = CkSFtp_readFileText(sftp,handle,26,"ansi");
    if (success != TRUE) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        return;
    }

    //  Should print "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
    printf("%s\n",sText);

    //  Close the file.
    success = CkSFtp_CloseHandle(sftp,handle);
    if (success != TRUE) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        return;
    }

    printf("Success.\n");

    CkSFtp_Dispose(sftp);

    }