This topic has not yet been rated - Rate this topic

DeflateStream.Read Method

Reads a number of decompressed bytes into the specified byte array.

Namespace:  System.IO.Compression
Assembly:  System (in System.dll)
public override int Read(
	byte[] array,
	int offset,
	int count
)

Parameters

array
Type: System.Byte[]

The array 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.Int32
The number of bytes that were read into the byte array.
ExceptionCondition
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.

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 (DeflateStream compressionStream = new DeflateStream(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 (DeflateStream decompressionStream = new DeflateStream(fileToDecompress, CompressionMode.Decompress))
                {
                    decompressionStream.Read(decompressedBytes, 0, bytesToCompress.Length);
                }
            }

            Console.WriteLine("ending with: " + uniEncode.GetString(decompressedBytes));
        }
    }
}

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, 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.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.