(PowerShell) 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 .NET Downloads Chilkat .NET Assemblies

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

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

$rest = New-Object Chilkat.Rest

# Connect to the web server
$bTls = $true
$port = 443
$bAutoReconnect = $true
$success = $rest.Connect("www.chilkatsoft.com",$port,$bTls,$bAutoReconnect)
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

# Setup a file stream for the download
$fileStream = New-Object 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.
$expectedStatus = 200
$rest.SetResponseBodyStream($expectedStatus,$true,$fileStream)

$responseStr = $rest.FullRequestNoBody("GET","/images/starfish.jpg")
if ($rest.LastMethodSuccess -eq $false) {
    # Examine the request/response to see what happened.
    $("response status code = " + $rest.ResponseStatusCode)
    $("response status text = " + $rest.ResponseStatusText)
    $("response header: " + $rest.ResponseHeader)
    $("response body (if any): " + $responseStr)
    $("---")
    $("LastRequestStartLine: " + $rest.LastRequestStartLine)
    $("LastRequestHeader: " + $rest.LastRequestHeader)
    exit
}

$("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.
$bd = New-Object Chilkat.BinData
$success = $rest.FullRequestNoBodyBd("GET","/images/penguins.jpg",$bd)
if ($success -eq $false) {
    # Examine the request/response to see what happened.
    $("response status code = " + $rest.ResponseStatusCode)
    $("response status text = " + $rest.ResponseStatusText)
    $("response header: " + $rest.ResponseHeader)
    $("response body (if any): " + $bd.GetString("utf-8"))
    $("---")
    $("LastRequestStartLine: " + $rest.LastRequestStartLine)
    $("LastRequestHeader: " + $rest.LastRequestHeader)
    exit
}

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

$("Success: " + $success)