Xceed Real-Time Zip for .NET Documentation
Xceed.Compression Assembly / Xceed.Compression Namespace / CompressedStream Class / SetupPPMdDecompression Method
The Stream that will be decompressed.


In This Topic
    SetupPPMdDecompression Method
    In This Topic
    Prepares PPMd decompression using the specified Stream and compression level.
    Syntax
    'Declaration
     
    Public Shared Function SetupPPMdDecompression( _
       ByVal compressedStream As Stream _
    ) As ManagedPPMdDecompressor
    'Usage
     
    Dim compressedStream As Stream
    Dim value As ManagedPPMdDecompressor
     
    value = CompressedStream.SetupPPMdDecompression(compressedStream)
    public static ManagedPPMdDecompressor SetupPPMdDecompression( 
       Stream compressedStream
    )

    Parameters

    compressedStream
    The Stream that will be decompressed.

    Return Value

    The ManagedPPMdDecompressor that will perform the decompression.
    Remarks

    The method calls ManagedPPMdDecompressor.ReadPPMdZipHeader to read the PPMd parameters from the stream. Then, it creates and returns an instance of ManagedPPMdDecompressor with the PPMd parameters.

    If the PPMd parameters read are invalid, a CompressionException will be thrown.

    This method effectively implements the Zip format as pertains to PPMd decompression for the CompressedStream class.

    The method can be useful when called from Xceed.Compression.Formats.FormattedCompressedStream.ReadHeader, in which it can be used as a complete custom header or as part of a larger header.

    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