FileStream.BeginRead(Byte[], Int32, Int32, AsyncCallback, Object) Method

Definition

Begins an asynchronous read operation. Consider using ReadAsync(Byte[], Int32, Int32, CancellationToken) instead.

public:
 override IAsyncResult ^ BeginRead(cli::array <System::Byte> ^ array, int offset, int numBytes, AsyncCallback ^ userCallback, System::Object ^ stateObject);
public override IAsyncResult BeginRead (byte[] array, int offset, int numBytes, AsyncCallback userCallback, object stateObject);
override this.BeginRead : byte[] * int * int * AsyncCallback * obj -> IAsyncResult
Public Overrides Function BeginRead (array As Byte(), offset As Integer, numBytes As Integer, userCallback As AsyncCallback, stateObject As Object) As IAsyncResult

Parameters

array
Byte[]

The buffer to read data into.

offset
Int32

The byte offset in array at which to begin reading.

numBytes
Int32

The maximum number of bytes to read.

callback
AsyncCallback

The method to be called when the asynchronous read operation is completed.

state
Object

A user-provided object that distinguishes this particular asynchronous read request from other requests.

Returns

An object that references the asynchronous read.

Exceptions

The array length minus offset is less than numBytes.

array is null.

offset or numBytes is negative.

An asynchronous read was attempted past the end of the file.

Applies to