Download an FTP File to a Stream

See more FTP Examples

Demonstrates the Chilkat Ftp2.GetFileToStream method, which downloads a remote file and writes its bytes to a Stream. The first argument is the remote file path and the second is the Stream, which must have a destination sink configured beforehand.

Note: The local paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

Background: Streaming to a Stream object decouples the download from where the bytes ultimately go — a file (as here, via SinkFile), or a pipe feeding another component such as a decompressor or a hashing routine — and processes the data as it arrives rather than buffering the whole file. That keeps memory flat for large downloads and lets you chain the transfer into a processing pipeline.

Chilkat C Downloads

Download Chilkat for C

#include <C_CkFtp2.h>
#include <C_CkStream.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkFtp2 ftp;
    HCkStream fileStream;

    success = FALSE;

    //  Demonstrates the Ftp2.GetFileToStream method, which downloads a remote file and writes its
    //  bytes to a Stream.  The 1st argument is the remote file path and the 2nd is the Stream.

    ftp = CkFtp2_Create();

    CkFtp2_putHostname(ftp,"ftp.example.com");
    CkFtp2_putUsername(ftp,"myFtpLogin");

    //  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.
    CkFtp2_putPassword(ftp,"myPassword");

    success = CkFtp2_Connect(ftp);
    if (success == FALSE) {
        printf("%s\n",CkFtp2_lastErrorText(ftp));
        CkFtp2_Dispose(ftp);
        return;
    }

    //  Configure the stream's destination sink before downloading.  Here the stream writes to a
    //  local file.
    fileStream = CkStream_Create();
    CkStream_putSinkFile(fileStream,"qa_output/report.pdf");

    success = CkFtp2_GetFileToStream(ftp,"public_html/report.pdf",fileStream);
    if (success == FALSE) {
        printf("%s\n",CkFtp2_lastErrorText(ftp));
        CkFtp2_Dispose(ftp);
        CkStream_Dispose(fileStream);
        return;
    }

    printf("Downloaded to stream.\n");

    success = CkFtp2_Disconnect(ftp);
    if (success == FALSE) {
        printf("%s\n",CkFtp2_lastErrorText(ftp));
        CkFtp2_Dispose(ftp);
        CkStream_Dispose(fileStream);
        return;
    }



    CkFtp2_Dispose(ftp);
    CkStream_Dispose(fileStream);

    }