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

Definition

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

C#
public override IAsyncResult BeginWrite (byte[] array, int offset, int count, AsyncCallback? asyncCallback, object? asyncState);
C#
public override IAsyncResult BeginWrite (byte[] buffer, int offset, int count, AsyncCallback? asyncCallback, object? asyncState);
C#
public override IAsyncResult BeginWrite (byte[] array, int offset, int count, AsyncCallback asyncCallback, object asyncState);

Parameters

arraybuffer
Byte[]

The buffer containing data to write to the current stream.

offset
Int32

The byte offset at which to begin writing.

count
Int32

The maximum number of bytes to write.

asyncCallback
AsyncCallback

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

asyncState
Object

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

Returns

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 .NET Framework 4.5, you can perform asynchronous write operations by using the Stream.WriteAsync method. The BeginWrite method is still available in current versions 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

Product Versions
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1