Xceed .NET Libraries Documentation
Xceed.Compression Assembly / Xceed.Compression Namespace / ManagedPPMdCompressor Class / Compress Method


In This Topic
    Compress Method (ManagedPPMdCompressor)
    In This Topic
    Compresses an array of bytes.
    Overload List
    OverloadDescription
    Compresses an array of bytes to an array of bytes.  
    Compresses an array of bytes to a Stream.  
    Remarks
    When the first call to Compress is made, a compression "session" is created. This session remains opened as long as Compress is called with the parameter endOfData set to False.

    During a compression session, the compression engine can choose to keep the data to compress in an internal buffer and return an empty array after a call to Compress. Many compression algorithms do this to get optimum compression by examining a certain number of bytes before compressing anything.

    A call to Compress with an empty buffer or a count of zero tells the compression engine to flush its internal buffer and return the compressed data. This may degrade the compression ratio.

    When Compress is called with the parameter endOfData set to True, the compression session is closed and all of the remaining compressed data is returned. The next call to Compress will create a new compression session.

    The compressed array may have a Length greater than the number of bytes returned by the call to Compress.

    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Standard: netstandard2.0, netstandard2.1

    .NET Framework: net20, net35, net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also