GZipStream.Read Method (Byte[], Int32, Int32)
Reads a number of decompressed bytes into the specified byte array.
Assembly: System (in System.dll)
Parameters
- array
-
Type:
System.Byte[]
The array used to store decompressed bytes.
- offset
-
Type:
System.Int32
The byte offset in array at which the read bytes will be placed.
- count
-
Type:
System.Int32
The maximum number of decompressed bytes to read.
Return Value
Type: System.Int32The number of bytes that were decompressed into the byte array. If the end of the stream has been reached, zero or the number of bytes read is returned.
| Exception | Condition |
|---|---|
| ArgumentNullException | array is null. |
| InvalidOperationException | The CompressionMode value was Compress when the object was created. - or - The underlying stream does not support reading. |
| ArgumentOutOfRangeException | offset or count is less than zero. -or- array length minus the index starting point is less than count. |
| InvalidDataException | The data is in an invalid format. |
| ObjectDisposedException | The stream is closed. |
If data is found in an invalid format, an InvalidDataException is thrown as one of the last operations. A cyclic redundancy check (CRC) is performed as one of the last operations of this method.
The following example shows how to compress and decompress bytes by using the Read and Write methods.
using System; using System.Text; using System.IO; using System.IO.Compression; namespace ExampleConsoleApplication { class Program { static void Main(string[] args) { UnicodeEncoding uniEncode = new UnicodeEncoding(); byte[] bytesToCompress = uniEncode.GetBytes("example text to compress and decompress"); Console.WriteLine("starting with: " + uniEncode.GetString(bytesToCompress)); using (FileStream fileToCompress = File.Create("examplefile.gz")) { using (GZipStream compressionStream = new GZipStream(fileToCompress, CompressionMode.Compress)) { compressionStream.Write(bytesToCompress, 0, bytesToCompress.Length); } } byte[] decompressedBytes = new byte[bytesToCompress.Length]; using (FileStream fileToDecompress = File.Open("examplefile.gz", FileMode.Open)) { using (GZipStream decompressionStream = new GZipStream(fileToDecompress, CompressionMode.Decompress)) { decompressionStream.Read(decompressedBytes, 0, bytesToCompress.Length); } } Console.WriteLine("ending with: " + uniEncode.GetString(decompressedBytes)); } } }
Available since 8
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Windows Phone
Available since 8.1