Unicode 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. Unicode C

#include <C_CkSFtpW.h>

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

    success = FALSE;

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

    sftp = CkSFtpW_Create();

    //  Set some timeouts, in milliseconds:
    CkSFtpW_putConnectTimeoutMs(sftp,5000);
    CkSFtpW_putIdleTimeoutMs(sftp,15000);

    //  Connect to the SSH server.  
    //  The standard SSH port = 22
    //  The hostname may be a hostname or IP address.
    hostname = L"sftp.example.com";
    port = 22;
    success = CkSFtpW_Connect(sftp,hostname,port);
    if (success != TRUE) {
        wprintf(L"%s\n",CkSFtpW_lastErrorText(sftp));
        CkSFtpW_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 = CkSFtpW_AuthenticatePw(sftp,L"myLogin",L"myPassword");
    if (success != TRUE) {
        wprintf(L"%s\n",CkSFtpW_lastErrorText(sftp));
        CkSFtpW_Dispose(sftp);
        return;
    }

    //  After authenticating, the SFTP subsystem must be initialized:
    success = CkSFtpW_InitializeSftp(sftp);
    if (success != TRUE) {
        wprintf(L"%s\n",CkSFtpW_lastErrorText(sftp));
        CkSFtpW_Dispose(sftp);
        return;
    }

    //  Open a file on the server:

    handle = CkSFtpW_openFile(sftp,L"hamlet.xml",L"readOnly",L"openExisting");
    if (CkSFtpW_getLastMethodSuccess(sftp) != TRUE) {
        wprintf(L"%s\n",CkSFtpW_lastErrorText(sftp));
        CkSFtpW_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 = CkSFtpW_GetFileSize32(sftp,handle,bFollowLinks,bIsHandle);
    if (numBytes < 0) {
        wprintf(L"%s\n",CkSFtpW_lastErrorText(sftp));
        CkSFtpW_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 = L"ansi";

    fileContents = CkSFtpW_readFileText(sftp,handle,numBytes,charset);
    if (CkSFtpW_getLastMethodSuccess(sftp) != TRUE) {
        wprintf(L"%s\n",CkSFtpW_lastErrorText(sftp));
        CkSFtpW_Dispose(sftp);
        return;
    }
    else {
        wprintf(L"Received file:\n");
        wprintf(L"%s\n",fileContents);
    }

    //  Close the file.
    success = CkSFtpW_CloseHandle(sftp,handle);
    if (success != TRUE) {
        wprintf(L"%s\n",CkSFtpW_lastErrorText(sftp));
        CkSFtpW_Dispose(sftp);
        return;
    }

    wprintf(L"Success.\n");


    CkSFtpW_Dispose(sftp);

    }