Stream a REST Response Body to a Destination

See more REST Examples

Demonstrates Rest.SetResponseBodyStream, which configures a Stream destination for response bodies received by the full-request convenience methods. The body is written to the stream only when the response status code matches the expected status.

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.

'  Configure a Stream destination for response bodies received by the full-request convenience
'  methods.  The body is written to the stream only when the response status code matches the 1st
'  argument.
Dim respStream As New ChilkatStream
respStream.SinkFile = "qa_output/response_body.dat"

'  The 2nd argument sets the stream character set from the response Content-Type charset for textual
'  responses.  The 3rd argument is the destination Stream.
Dim bAutoSetCharset As Long
bAutoSetCharset = 1
Dim expectedStatus As Long
expectedStatus = 200
success = rest.SetResponseBodyStream(expectedStatus,bAutoSetCharset,respStream)
If (success = 0) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

'  The full-request call now streams the response body to the sink instead of returning it.
Dim responseText As String
responseText = rest.FullRequestNoBody("GET","/api/largefile")
If (rest.LastMethodSuccess = 0) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

Debug.Print "Response streamed to file.  Status: " & rest.ResponseStatusCode