C

SFTP Read Text File to String

See more SFTP Examples

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

#include <C_CkSFtp.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkSFtp sftp;
    const char *hostname;
    int port;
    const char *handle;
    BOOL bFollowLinks;
    BOOL bIsHandle;
    int numBytes;
    const char *charset;
    const char *fileContents;

    success = FALSE;

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

    sftp = CkSFtp_Create();

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

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

    //  Open a file on the server:

    handle = CkSFtp_openFile(sftp,"hamlet.xml","readOnly","openExisting");
    if (CkSFtp_getLastMethodSuccess(sftp) != TRUE) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        CkSFtp_Dispose(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 alternative 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));
        CkSFtp_Dispose(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";

    fileContents = CkSFtp_readFileText(sftp,handle,numBytes,charset);
    if (CkSFtp_getLastMethodSuccess(sftp) != TRUE) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        CkSFtp_Dispose(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));
        CkSFtp_Dispose(sftp);
        return;
    }

    printf("Success.\n");


    CkSFtp_Dispose(sftp);

    }