Export (0) Print
Expand All

DeflateStream Constructor (Stream, CompressionMode)

Initializes a new instance of the DeflateStream class using the specified stream and CompressionMode value.

Namespace:  System.IO.Compression
Assembly:  System (in System.dll)

public:
DeflateStream(
	Stream^ stream, 
	CompressionMode mode
)

Parameters

stream
Type: System.IO::Stream
The stream to compress or decompress.
mode
Type: System.IO.Compression::CompressionMode
One of the CompressionMode values that indicates the action to take.

ExceptionCondition
ArgumentNullException

stream is nullptr.

ArgumentException

mode is not a valid CompressionMode value.

-or-

CompressionMode is Compress and CanWrite is false.

-or-

CompressionMode is Decompress and CanRead is false.

By default, DeflateStream owns the underlying stream, so closing the stream also closes the underlying stream. Note that the state of the underlying stream can affect the usability of the stream. Also, no explicit checks are performed, so no additional exceptions are thrown when the new instance is created.

If an instance of the DeflateStream class is created with the mode parameter equal to Compress, header information is inserted immediately. If no further action occurs, the stream appears as a valid, empty, compressed file.

Using the DeflateStream class to compress a file larger than 4 GB raises an exception.

The following example shows how to use the DeflateStream class to compress and decompress a file.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2014 Microsoft