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 Boolean = False

Dim rest As New Chilkat.Rest
Dim bTls As Boolean = True
Dim bAutoReconnect As Boolean = True
success = rest.Connect("example.com",443,bTls,bAutoReconnect)
If (success = False) Then
    Debug.WriteLine(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 Chilkat.Stream
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 Boolean = True
Dim expectedStatus As Integer = 200
success = rest.SetResponseBodyStream(expectedStatus,bAutoSetCharset,respStream)
If (success = False) Then
    Debug.WriteLine(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 = rest.FullRequestNoBody("GET","/api/largefile")
If (rest.LastMethodSuccess = False) Then
    Debug.WriteLine(rest.LastErrorText)
    Exit Sub
End If

Debug.WriteLine("Response streamed to file.  Status: " & rest.ResponseStatusCode)