Detect End-of-File on a Remote SFTP File

See more SFTP Examples

Demonstrates the Chilkat SFtp.Eof method, which returns whether the most recent read for a handle received the SFTP end-of-file status. The only argument is the handle. This example reads until Eof is true.

Background: The timing here is worth understanding: reading exactly through the final byte does not immediately set EOF. The next read succeeds, returns zero bytes, sets the status to SSH_FX_EOF, and only then does Eof report true. That is why the loop tests Eof after each read rather than assuming a short read means the end — a short read can also just be the server returning less than requested.

Chilkat C Downloads

Download Chilkat for C

#include <C_CkSFtp.h>
#include <C_CkStringBuilder.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkSFtp sftp;
    int port;
    const char *password;
    const char *handle;
    HCkStringBuilder sbContent;
    int chunkSize;
    BOOL reading;
    const char *chunk;

    success = FALSE;

    //  Demonstrates the SFtp.Eof method, which returns whether the most recent read for a handle
    //  received the SFTP end-of-file status.  The only argument is the handle.

    sftp = CkSFtp_Create();

    //  Connect, authenticate, and initialize the SFTP subsystem.
    port = 22;
    success = CkSFtp_Connect(sftp,"sftp.example.com",port);
    if (success == FALSE) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        CkSFtp_Dispose(sftp);
        return;
    }

    //  Normally you would not hard-code the password in source.  You should instead obtain it
    //  from an interactive prompt, environment variable, or a secrets vault.
    password = "mySshPassword";

    success = CkSFtp_AuthenticatePw(sftp,"mySshLogin",password);
    if (success == FALSE) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        CkSFtp_Dispose(sftp);
        return;
    }

    success = CkSFtp_InitializeSftp(sftp);
    if (success == FALSE) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        CkSFtp_Dispose(sftp);
        return;
    }

    handle = CkSFtp_openFile(sftp,"subdir/data.txt","readOnly","openExisting");
    if (CkSFtp_getLastMethodSuccess(sftp) == FALSE) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        CkSFtp_Dispose(sftp);
        return;
    }

    //  Read until Eof reports the end of the file.  Note that reading exactly through the final byte
    //  does not set EOF; the next read returns zero bytes and then Eof becomes true.
    sbContent = CkStringBuilder_Create();
    chunkSize = 4096;
    reading = TRUE;
    while (reading) {
        chunk = CkSFtp_readFileText(sftp,handle,chunkSize,"utf-8");
        if (CkSFtp_LastReadFailed(sftp,handle)) {
            printf("%s\n",CkSFtp_lastErrorText(sftp));
            CkSFtp_Dispose(sftp);
            CkStringBuilder_Dispose(sbContent);
            return;
        }

        CkStringBuilder_Append(sbContent,chunk);
        reading = !CkSFtp_Eof(sftp,handle);
    }

    success = CkSFtp_CloseHandle(sftp,handle);
    if (success == FALSE) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        CkSFtp_Dispose(sftp);
        CkStringBuilder_Dispose(sbContent);
        return;
    }

    printf("%s\n",CkStringBuilder_getAsString(sbContent));

    CkSFtp_Disconnect(sftp);


    CkSFtp_Dispose(sftp);
    CkStringBuilder_Dispose(sbContent);

    }