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 override int EndRead(
	IAsyncResult asyncResult
)

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 null.

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.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5

XNA Framework

Supported in: 3.0
Show: