Read the REST Response Body into a Stream

See more REST Examples

Demonstrates Rest.ReadRespBodyStream, which reads the response body into a Stream. The optional flag sets the stream character set from the response Content-Type charset for textual responses.

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

Dim success As Long
success = 0

Dim rest As New ChilkatRest
Dim bTls As Long
bTls = 1
Dim bAutoReconnect As Long
bAutoReconnect = 1
success = rest.Connect("example.com",443,bTls,bAutoReconnect)
If (success = 0) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

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

success = rest.SendReqNoBody("GET","/api/images/1")
If (success = 0) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

Dim statusCode As Long
statusCode = rest.ReadResponseHeader()
If (statusCode < 0) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

'  Check for the expected success status code.  If the response is not 200, the body is likely
'  error text formatted as JSON, XML, or HTML rather than the expected binary content.  In that case
'  read the body as text, report it, and return.
If (statusCode <> 200) Then
    Dim sbError As New ChilkatStringBuilder
    success = rest.ReadRespSb(sbError)
    If (success = 0) Then
        Debug.Print rest.LastErrorText
        Exit Sub
    End If

    Debug.Print "Request failed with status code " & statusCode
    Debug.Print sbError.GetAsString()
    Exit Sub
End If

'  The status code is 200.  Read the response body into a Stream.  Here the stream's sink is a local
'  file, which is appropriate for large or binary responses.
Dim respStream As New ChilkatStream
respStream.SinkFile = "qa_output/image.png"

'  If the 2nd argument is 1 and the response is textual, the stream's character set is set from
'  the response Content-Type charset.  It has no effect for binary responses.
Dim bAutoSetCharset As Long
bAutoSetCharset = 1
success = rest.ReadRespBodyStream(respStream,bAutoSetCharset)
If (success = 0) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

Debug.Print "Response body written to the stream sink."