Xojo Plugin

HTTP Download to Stream

See more REST Examples

Demonstrates how to stream the response body directly to a stream, which in this case is to a file stream. Xojo Plugin

Dim success As Boolean
success = False

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

Dim rest As New Chilkat.Rest

// The URL we want to download is: 
// https://github.com/chilkatsoft/OAuth2-CSharp-Desktop/archive/master.zip
Dim url As New Chilkat.Url
success = url.ParseUrl("https://github.com/chilkatsoft/OAuth2-CSharp-Desktop/archive/master.zip")

// Connect to the web server
Dim bAutoReconnect As Boolean
bAutoReconnect = True
success = rest.Connect(url.Host,url.Port,url.Ssl,bAutoReconnect)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

success = rest.SendReqNoBody("GET",url.Path)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

// Read the response header.
Dim responseStatusCode As Int32
responseStatusCode = rest.ReadResponseHeader()
If (responseStatusCode < 0) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

System.DebugLog("Response status code = " + Str(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 New Chilkat.Stream

    // The stream's sink will be a file.
    bodyStream.SinkFile = "qa_output/OAuth2-CSharp-Desktop/archive/master.zip"

    // 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
        System.DebugLog(rest.LastErrorText)
        Return
    End If

    System.DebugLog("Successfully downloaded the file.")

Else
    Dim errResponse As String
    errResponse = rest.ReadRespBodyString()
    If (rest.LastMethodSuccess <> True) Then
        System.DebugLog(rest.LastErrorText)
    Else
        System.DebugLog(errResponse)
    End If

End If