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)
Parameters
- stream
- Type: System.IO.Stream
The stream to compress or decompress.
- 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.
| Exception | Condition |
|---|---|
| ArgumentNullException | stream is null. |
| 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.
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
