(Excel) HTTP POST and Stream Response to File

Demonstrates how to send an HTTP POST and stream the response body directly to a file.

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

Dim url As Chilkat.Url
Set url = Chilkat.NewUrl
' This URL will emit a response that echos the query params (name and age)
Dim success As Boolean
success = url.ParseUrl("https://www.chilkatsoft.com/readPost.asp")

' Connect to the web server

bAutoReconnect = True

success = rest.Connect(url.Host,url.Port,url.Ssl,bAutoReconnect)
If (success <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

success = rest.AddQueryParam("name","John")
success = rest.AddQueryParam("age","33")

'  Send the HTTP POST.
success = rest.SendReqFormUrlEncoded("POST",url.Path)
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 file 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/out.txt"

    ' 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 streamed the response to a file."

Else

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

End If