Xceed .NET Libraries Documentation
Xceed.Compression Assembly / Xceed.Compression Namespace / ManagedPPMdDecompressor Class / ReadPPMdZipHeader Method
The stream the header will be read from.
The allocator size.
The maximum model order.
Method of model restoration if memory is insufficient.


In This Topic
    ReadPPMdZipHeader Method
    In This Topic
    Reads PPMd algorithm properties from the specified stream using the Zip Specification format.
    Syntax
    'Declaration
     
    
    Public Shared Function ReadPPMdZipHeader( _
       ByVal stream As Stream, _
       ByRef allocatorSize As Integer, _
       ByRef modelOrder As Byte, _
       ByRef method As ModelRestorationMethod _
    ) As Boolean
    'Usage
     
    
    Dim stream As Stream
    Dim allocatorSize As Integer
    Dim modelOrder As Byte
    Dim method As ModelRestorationMethod
    Dim value As Boolean
     
    value = ManagedPPMdDecompressor.ReadPPMdZipHeader(stream, allocatorSize, modelOrder, method)
    public static bool ReadPPMdZipHeader( 
       Stream stream,
       out int allocatorSize,
       out byte modelOrder,
       out ModelRestorationMethod method
    )

    Parameters

    stream
    The stream the header will be read from.
    allocatorSize
    The allocator size.
    modelOrder
    The maximum model order.
    method
    Method of model restoration if memory is insufficient.

    Return Value

    true if not at the end of the stream; false otherwise.
    Remarks

    The header is 2 bytes long and has the following format. In C, the header would be defined like this (from least-significant to most-significant bit):

    struct PPMdZipHeader
    {
      unsigned short modelOrder : 4;
      unsigned short AllocatorSize : 8;
      unsigned short Method : 4;
    };

    The values are read with the Intel little-endian byte order.

    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