Read the REST Response Body in Chunks

See more REST Examples

Demonstrates Rest.ReadRespChunkBd, which reads the response body one chunk at a time, appending each chunk to a BinData. A return value of 0 signals the body is complete, while -1 indicates a read failure.

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

$success = $false

$rest = New-Object Chilkat.Rest
$bTls = $true
$bAutoReconnect = $true
$success = $rest.Connect("example.com",443,$bTls,$bAutoReconnect)
if ($success -eq $false) {
    $($rest.LastErrorText)
    exit
}

$success = $rest.SendReqNoBody("GET","/api/largefile")
if ($success -eq $false) {
    $($rest.LastErrorText)
    exit
}

$statusCode = $rest.ReadResponseHeader()
if ($statusCode -lt 0) {
    $($rest.LastErrorText)
    exit
}

#  Read the response body in chunks, appending each chunk to the BinData.  Each call waits until at
#  least the requested number of bytes is available, unless the response ends first.  A return value
#  of 0 means the final bytes were returned and the body is complete; -1 indicates a read failure.
$bdBody = New-Object Chilkat.BinData
$chunkResult = $rest.ReadRespChunkBd(8192,$bdBody)
while ($chunkResult -gt 0) {
    $chunkResult = $rest.ReadRespChunkBd(8192,$bdBody)
}

if ($chunkResult -lt 0) {
    $($rest.LastErrorText)
    exit
}

$("Received " + $bdBody.NumBytes + " bytes.")