GZipStream Constructor (Stream, CompressionMode)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

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

new : 
        stream:Stream *
        mode:CompressionMode -> 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.

Exception Condition
ArgumentNullException

stream is null.

ArgumentException

mode is not a valid CompressionMode enumeration 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.

The following example initializes a new instance of the GZipStream class with mode set to Compress. This example is part of a larger example provided for the GZipStream class.

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

Universal Windows Platform
Available since 8
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Windows Phone
Available since 8.1
Return to top
Show: