VBScript

Read the REST Response Body into a Stream

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.

Background. The staged request model separates sending from reading: a SendReq method transmits the request, ReadResponseHeader reads the status line and headers, and a ReadResp method reads the body. This gives fine control over large or streamed messages compared with the single-call full-request methods.

Chilkat VBScript Downloads

Download Chilkat for VBScript

VBScript

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

success = 0

set rest = CreateObject("Chilkat.Rest")
bTls = 1
bAutoReconnect = 1
success = rest.Connect("example.com",443,bTls,bAutoReconnect)
If (success = 0) Then
    outFile.WriteLine(rest.LastErrorText)
    WScript.Quit
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
    outFile.WriteLine(rest.LastErrorText)
    WScript.Quit
End If

statusCode = rest.ReadResponseHeader()
If (statusCode < 0) Then
    outFile.WriteLine(rest.LastErrorText)
    WScript.Quit
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
    set sbError = CreateObject("Chilkat.StringBuilder")
    success = rest.ReadRespSb(sbError)
    If (success = 0) Then
        outFile.WriteLine(rest.LastErrorText)
        WScript.Quit
    End If

    outFile.WriteLine("Request failed with status code " & statusCode)
    outFile.WriteLine(sbError.GetAsString())
    WScript.Quit
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.
set respStream = CreateObject("Chilkat.Stream")
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.
bAutoSetCharset = 1
success = rest.ReadRespBodyStream(respStream,bAutoSetCharset)
If (success = 0) Then
    outFile.WriteLine(rest.LastErrorText)
    WScript.Quit
End If

outFile.WriteLine("Response body written to the stream sink.")

outFile.Close