(Xojo Plugin) Explaining the Rest ClearResponseBodyStream Method

See more Azure Cloud Storage Examples

The ClearResponseBodyStream method would be needed if your applicaiton called SetResponseBodyStream to send the response to a stream for one request, but then wants to subsequently do something else. The application must call ClearResponseBodyStream to no longer send responses to the stream.

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

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

Dim rest As New Chilkat.Rest

// Connect to the web server
Dim bTls As Boolean
bTls = True
Dim port As Int32
port = 443
Dim bAutoReconnect As Boolean
bAutoReconnect = True
Dim success As Boolean
success = rest.Connect("www.chilkatsoft.com",port,bTls,bAutoReconnect)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

// Setup a file stream for the download
Dim fileStream As New Chilkat.Stream
fileStream.SinkFile = "qa_output/starfish.jpg"

// Indicate that the call to FullRequestNoBody should send the response body
// to fileStream if the response status code is 200.
// If a non-success response status code is received, then nothing
// is streamed to the output file and the error response is returned by FullRequestNoBody.
Dim expectedStatus As Int32
expectedStatus = 200
success = rest.SetResponseBodyStream(expectedStatus,True,fileStream)

Dim responseStr As String
responseStr = rest.FullRequestNoBody("GET","/images/starfish.jpg")
If (rest.LastMethodSuccess = False) Then
    // Examine the request/response to see what happened.
    System.DebugLog("response status code = " + Str(rest.ResponseStatusCode))
    System.DebugLog("response status text = " + rest.ResponseStatusText)
    System.DebugLog("response header: " + rest.ResponseHeader)
    System.DebugLog("response body (if any): " + responseStr)
    System.DebugLog("---")
    System.DebugLog("LastRequestStartLine: " + rest.LastRequestStartLine)
    System.DebugLog("LastRequestHeader: " + rest.LastRequestHeader)
    Return
End If

System.DebugLog("downloaded starfish.jpg")

// Clear the response body stream previously set in the call to SetResponseBodyStream.
rest.ClearResponseBodyStream 

// Download something else, but this time send the response body to bd.
Dim bd As New Chilkat.BinData
success = rest.FullRequestNoBodyBd("GET","/images/penguins.jpg",bd)
If (success = False) Then
    // Examine the request/response to see what happened.
    System.DebugLog("response status code = " + Str(rest.ResponseStatusCode))
    System.DebugLog("response status text = " + rest.ResponseStatusText)
    System.DebugLog("response header: " + rest.ResponseHeader)
    System.DebugLog("response body (if any): " + bd.GetString("utf-8"))
    System.DebugLog("---")
    System.DebugLog("LastRequestStartLine: " + rest.LastRequestStartLine)
    System.DebugLog("LastRequestHeader: " + rest.LastRequestHeader)
    Return
End If

// Save the contents of bd to a file.
success = bd.WriteFile("qa_output/penguins.jpg")

System.DebugLog("Success: " + Str(success))