This documentation is archived and is not being maintained.

GZipStream::EndRead Method

Waits for the pending asynchronous read to complete.

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

public:
virtual int EndRead(
	IAsyncResult^ asyncResult
) override

Parameters

asyncResult
Type: System::IAsyncResult
The reference to the pending asynchronous request to finish.

Return Value

Type: System::Int32
The number of bytes read from the stream, between zero (0) and the number of bytes you requested. GZipStream returns zero (0) only at the end of the stream; otherwise, it blocks until at least one byte is available.

ExceptionCondition
ArgumentNullException

asyncResult is nullptr.

ArgumentException

asyncResult did not originate from a BeginRead method on the current stream.

InvalidOperationException

The end operation cannot be performed because the stream is closed.

Call this method to determine how many bytes were read from the stream. This method can be called once to return the amount of bytes read between calls to BeginRead and EndRead.

This method blocks until the I/O operation has completed.

The following code example shows how to use the GZipStream class to compress and decompress a file.

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

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: