SFTP Read Text File to String

Demonstrates how to download a text file from an SSH server directly into a string variable.

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;
    BOOL bFollowLinks;
    BOOL bIsHandle;
    long numBytes;
    const char * charset;
    long offset32;
    const char * fileContents;

    //  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 on the server:

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

    //  Get the total size of this file (in bytes)

    bFollowLinks = FALSE;

    bIsHandle = TRUE;

    //  bFollowLinks is ignored because we are passing a handle
    //  and not a remote filename.
    //  There are atlernative methods for handling file sizes
    //  greater than 32-bit.  (See the reference documentation.)
    numBytes = CkSFtp_GetFileSize32(sftp,handle,bFollowLinks,bIsHandle);
    if (numBytes < 0) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        return;
    }

    //  The charset indicates the character encoding of the text
    //  file on the SSH server.   Setting the charset correctly
    //  allows the Chilkat SFTP component to correctly interpret
    //  the bytes that represent the characters.

    charset = "ansi";

    offset32 = 0;

    fileContents = CkSFtp_readFileText32(sftp,handle,offset32,numBytes,charset);
    if (fileContents == 0 ) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        return;
    }
    else {
        printf("Received file:\n");
        printf("%s\n",fileContents);
    }

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

    printf("Success.\n");

    CkSFtp_Dispose(sftp);

    }