ZLib .NET Wrapper

This project contains the following classes:

• CompressionStream - a Stream-derived class that can be used to compress or decompress data using ZLib's deflate and inflate functions.
• ZLibException - an Exception-derived class thrown if ZLib generates an error.
• Compress - a BinaryWriter-derived class that wraps a CompressionStream object.
• Decompress - a BinaryReader-derived class that wraps a CompressionStream object.
• Base64Stream - a Stream-derived class that can be used to encode or decode Base-64 text data.

Note that since this is a mixed mode .DLL implementation, the client application must call, ManagedZLib.ManagedZLib.Initialize() before using the compression classes, and call ManagedZLib.ManagedZLib.Terminate() to release the .DLL's resources. See the following for more information:

• http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dv_vstechart/html/vcconMixedDLLLoadingProblem.asp
• http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vcmex/html/vcconconvertingmanagedextensionsforcprojectsfrompureintermediatelanguagetomixedmode.asp

CompressionStream

ManagedZLib.CompressionStream : System.IO.Stream

This class wraps the ZLib deflate and inflate functions in a .NET System.Stream object.

CompressionStream( Stream stream, CompressionOptions option )

Creates an instance of the compression stream object.

stream - The underlying stream that will be used to either read compressed data from or write compressed data to.

option - Specify the option to use when opening the compression stream object. The following options are available:

• CompressionOptions.Decompress - Decompress data.
• CompressionOptions.Compress - Compress data using the default compression level.
• CompressionOptions.CompressNone - Do not compress data (although header information will be added).
• CompressionOptions.CompressFast - Compress using the fastest method.
• CompressionOptions.CompressLevelZero - Same as CompressionOptions.CompressNone.
• CompressionOptions.CompressLevelOne - Same as CompressionOptions.CompressFast.
• CompressionOptions.CompressLevelTwo - Compress data better, but slower.
• CompressionOptions.CompressLevelThree
• CompressionOptions.CompressLevelFour
• CompressionOptions.CompressLevelFive
• CompressionOptions.CompressLevelSix
• CompressionOptions.CompressLevelSeven
• CompressionOptions.CompressLevelEight
• CompressionOptions.CompressLevelNine - Same as CompressionOptions.CompressBest.
• CompressionOptions.CompressBest - Compress using the best compression, but the slowest speed.

static string ZLibVersion

Returns the version of ZLib being used for the compression ("1.2.2").

static CompressionOptions GetLevel( int level )

Translates a numeric level (0-9) into one of the CompressionOptions enumerated values. Invalid values are just translated in the default compression level.

The following properties are used to obtain information about the compression or decompression. Each of these properties are available after the stream has been closed.

unsigned int CRC

Returns the CRC of the uncompressed data.

unsigned long BytesIn

When compressing data, returns the number of uncompressed bytes written to this stream object. When decompressing data, returns the number of compressed bytes read from the source stream.

unsigned long BytesOut

When compressing data, returns the number of compressed bytes written to the destination stream. When decompressing data, returns the number of uncompressed bytes read from this stream object.

double CompressionRatio

Returns the percent compression of the data.

Two thin wrapper classes are also available, Compress (derived from BinaryWriter) and Decompress (derived from BinaryReader). These classes are used exactly like the concrete BinaryWriter and BinaryReader classes, except that a CompressionStream object is inserted between the class and the stream object you provide. Also these classes publish the same CRC, BytesIn, BytesOut, and CompressionRatio properties as the CompressionStream object.

Base64Stream

ManagedZLib.Base64Stream : System.IO.Stream

This class wraps the Base-64 encoding and decoding functions in a .NET System.Stream object.

Base64Stream( Stream stream, Base64Options option )

Creates an instance of the Base-64 stream object.

stream - The underlying stream that will be used to either read decoded data from or write encoded data to.

option - Specify the option to use when opening the compression stream object. The following options are available:

• Base64Options.Encode - Encode into Base-64 data stream.
• Base64Options.Decode - Decode Base-64 data stream.

Additional Resources

Project Home Page

ZLib Home Page

Product License

Change Log