Xceed .NET Libraries Documentation
ReadPPMdZipHeader Method


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.
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.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

ManagedPPMdDecompressor Class
ManagedPPMdDecompressor Members