GZipStream.BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object) Method

Definition

Begins an asynchronous write operation. (Consider using the WriteAsync(Byte[], Int32, Int32) method instead.)

public:
 override IAsyncResult ^ BeginWrite(cli::array <System::Byte> ^ array, int offset, int count, AsyncCallback ^ asyncCallback, System::Object ^ asyncState);
public:
 override IAsyncResult ^ BeginWrite(cli::array <System::Byte> ^ buffer, int offset, int count, AsyncCallback ^ cback, System::Object ^ state);
public override IAsyncResult BeginWrite (byte[] array, int offset, int count, AsyncCallback asyncCallback, object asyncState);
public override IAsyncResult BeginWrite (byte[] buffer, int offset, int count, AsyncCallback cback, object state);
override this.BeginWrite : byte[] * int * int * AsyncCallback * obj -> IAsyncResult
override this.BeginWrite : byte[] * int * int * AsyncCallback * obj -> IAsyncResult
Public Overrides Function BeginWrite (array As Byte(), offset As Integer, count As Integer, asyncCallback As AsyncCallback, asyncState As Object) As IAsyncResult
Public Overrides Function BeginWrite (buffer As Byte(), offset As Integer, count As Integer, cback As AsyncCallback, state As Object) As IAsyncResult

Parameters

arraybuffer
Byte[]

The buffer containing data to write to the current stream.

offset
Int32

The byte offset in array at which to begin writing.

count
Int32

The maximum number of bytes to write.

asyncCallbackcback
AsyncCallback

An optional asynchronous callback to be called when the write operation is complete.

asyncStatestate
Object

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

Returns

IAsyncResult

An object that represents the asynchronous write operation, which could still be pending.

Exceptions

The underlying stream is null.

-or-

The underlying stream is closed.

Remarks

Starting with the .NET Framework 4.5, you can perform asynchronous write operations by using the Stream.WriteAsync method. The BeginWrite 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.

The BeginWrite method starts an asynchronous write operation to a GZipStream stream object.

You must create a callback method that implements the AsyncCallback delegate and pass its name to the BeginWrite method.

Applies to