GZipStream.EndRead(IAsyncResult) Method

Definition

Waits for the pending asynchronous read to complete. (Consider using the ReadAsync(Byte[], Int32, Int32) method instead.)

public:
 override int EndRead(IAsyncResult ^ asyncResult);
public:
 override int EndRead(IAsyncResult ^ async_result);
public override int EndRead (IAsyncResult asyncResult);
public override int EndRead (IAsyncResult async_result);
override this.EndRead : IAsyncResult -> int
override this.EndRead : IAsyncResult -> int
Public Overrides Function EndRead (asyncResult As IAsyncResult) As Integer
Public Overrides Function EndRead (async_result As IAsyncResult) As Integer

Parameters

asyncResultasync_result
IAsyncResult

The reference to the pending asynchronous request to finish.

Returns

Int32

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

Exceptions

asyncResult is null.

asyncResult did not originate from a BeginRead(Byte[], Int32, Int32, AsyncCallback, Object) method on the current stream.

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

Remarks

Starting with the .NET Framework 4.5, you can perform asynchronous read operations by using the Stream.ReadAsync method. The EndRead method is still available in .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.

Applies to