(Excel) REST Stream Response to File (Streaming Download) (Amazon S3)

Demonstrates how to stream the response body directly to a file. (The example shows how to stream a JPG from the Amazon S3 service.)

Download Excel Class Modules Chilkat Excel Class Modules

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

Dim rest As Chilkat.Rest
Set rest = Chilkat.NewRest

' Connect to the Amazon AWS REST server.

bTls = True

port = 443

bAutoReconnect = True

success = rest.Connect("s3.amazonaws.com",port,bTls,bAutoReconnect)

' ----------------------------------------------------------------------------
' Important: For buckets created in regions outside us-east-1,
' there are three important changes that need to be made.
' See Working with S3 Buckets in Non-us-east-1 Regions for the details.
' ----------------------------------------------------------------------------

' Provide AWS credentials for the REST call.
Dim authAws As Chilkat.AuthAws
Set authAws = Chilkat.NewAuthAws
authAws.AccessKey = "AWS_ACCESS_KEY"
authAws.SecretKey = "AWS_SECRET_KEY"
authAws.ServiceName = "s3"
success = rest.SetAuthAws(authAws)

' Set the bucket name via the HOST header.
' In this case, the bucket name is "chilkat100".
rest.Host = "chilkat100.s3.amazonaws.com"

' Send the request to download the JPG.
success = rest.SendReqNoBody("GET","/starfish.jpg")
If (success <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

' Read the response header.

responseStatusCode = rest.ReadResponseHeader()
If (responseStatusCode < 0) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

Debug.Print "Response status code = "; responseStatusCode

' We expect a 200 response status if the JPG data is coming.
' Otherwise, we'll get a string response body with an error message(or no response body).
If (responseStatusCode = 200) Then

    Dim bodyStream As Chilkat.Stream
    Set bodyStream = Chilkat.NewStream

    ' The stream's sink will be a file.
    bodyStream.SinkFile = "qa_output/starfish.jpg"

    ' Read the response body to the stream.  Given that we've
    ' set the stream's sink to a file, it will stream directly
    ' to the file.
    success = rest.ReadRespBodyStream(bodyStream,True)
    If (success <> True) Then
        Debug.Print rest.LastErrorText
        Exit Sub
    End If

    Debug.Print "Successfully received the JPG file."

Else

    errResponse = rest.ReadRespBodyString()
    If (rest.LastMethodSuccess <> True) Then
        Debug.Print rest.LastErrorText
    Else
        Debug.Print errResponse
    End If

End If