Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

GZipStream Constructor (Stream, CompressionMode, Boolean)

Initializes a new instance of the GZipStream class by using the specified stream and compression mode, and optionally leaves the stream open.

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

new : 
        stream:Stream * 
        mode:CompressionMode * 
        leaveOpen:bool -> GZipStream

Parameters

stream
Type: System.IO.Stream

The stream the compressed or decompressed data is written to.

mode
Type: System.IO.Compression.CompressionMode

One of the enumeration values that indicates whether to compress or decompress the stream.

leaveOpen
Type: System.Boolean

true to leave the stream open after disposing the GZipStream object; otherwise, false.

ExceptionCondition
ArgumentNullException

stream is a null reference (Nothing in Visual Basic).

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, GZipStream owns the underlying stream, so closing the stream parameter 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 GZipStream class is created with the mode parameter equal to Compress and no further action occurs, the stream will appear as a valid, empty compressed file.

By default, the compression level is set to Optimal when the compression mode is Compress.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0

.NET for Windows Phone apps

Supported in: Windows Phone 8.1

Portable Class Library

Supported in: Portable Class Library
Show:
© 2015 Microsoft