MemoryStream.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> ^ buffer, int offset, int count, AsyncCallback ^ callback, System::Object ^ state);
public override IAsyncResult BeginRead (byte[] buffer, int offset, int count, AsyncCallback callback, object state);
override this.BeginRead : byte[] * int * int * AsyncCallback * obj -> IAsyncResult
Public Overrides Function BeginRead (buffer As Byte(), offset As Integer, count As Integer, callback As AsyncCallback, state As Object) As IAsyncResult

Parameters

buffer
Byte[]

The buffer to read the data into.

offset
Int32

The byte offset in buffer at which to begin writing data read from the memory stream.

count
Int32

The maximum number of bytes to read.

callback
AsyncCallback

An optional asynchronous callback, to be called when the read is complete.

state
Object

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

Returns

An IAsyncResult that represents the asynchronous read, which could still be pending.

Exceptions

Attempted an asynchronous read past the end of the memory stream, or a disk error occurred.

One or more of the arguments is invalid.

Methods were called after the memory stream was closed.

The current memory stream implementation does not support the read operation.

Remarks

Refer to the BeginRead remarks for additional usage information for this method.

Applies to