(PowerShell) Compress Text from StringBuilder to Gzip (BinData Output)

See more Gzip Examples

This example demonstrates how to use the CompressSb method to compress text stored in a StringBuilder into Gzip format.

The text is first converted to its byte representation using the specified character set (in this case, UTF-8). These bytes are then compressed, and the resulting Gzip data is written to a BinData object in memory.

This approach is useful when working with dynamically generated text that you want to compress without first writing it to a file. The example also shows how the compressed data can optionally be saved to a .gz file.

Chilkat .NET Downloads Chilkat .NET Assemblies

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

$success = $false

# This example demonstrates how to compress text contained in a StringBuilder
# into Gzip format, storing the compressed result in a BinData object.

$gzip = New-Object Chilkat.Gzip
$sb = New-Object Chilkat.StringBuilder
$bd = New-Object Chilkat.BinData

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

# Add some text to the StringBuilder:
$sb.Append("The quick brown fox jumps over the lazy dog.")

# Compress the text using UTF-8 encoding:
$success = $gzip.CompressSb($sb,"utf-8",$bd)
if ($success -eq $false) {
    $($gzip.LastErrorText)
    exit
}

# The BinData now contains the Gzip-compressed bytes.
$("Compression successful.")
$("Compressed size (bytes): " + $bd.NumBytes)

# (Optional) Save to a .gz file:
$success = $bd.WriteFile("text.gz")
if ($success -eq $false) {
    $($bd.LastErrorText)
    exit
}

$("Gzip file written to text.gz")