Export (0) Print
Expand All

DeflateStream.EndRead Method

Waits for the pending asynchronous read to complete. (Consider using the ReadAsync method instead; see the Remarks section.)

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

'Declaration
Public Overrides Function EndRead ( _
	asyncResult As IAsyncResult _
) As Integer

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 0 (zero) and the number of bytes you requested. DeflateStream returns 0 only at the end of the stream; otherwise, it blocks until at least one byte is available.

ExceptionCondition
ArgumentNullException

asyncResult is Nothing.

ArgumentException

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

SystemException

An exception was thrown during a call to WaitOne.

InvalidOperationException

The end call is invalid because asynchronous read operations for this stream are not yet complete.

InvalidOperationException

The stream is Nothing.

Starting with the .NET Framework 4.5, you can perform asynchronous read operations by using the ReadAsync method. The EndRead method is still available in the .NET Framework 4.5 to support legacy code; however, you can implement asynchronous I/O operations more easily by using the new async methods. For more information, see Asynchronous File I/O.

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.

.NET Framework

Supported in: 4.5.2, 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

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.

Show:
© 2014 Microsoft