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

Definition

Namespace:

System.IO.Compression

Assembly:

System.IO.Compression.dll

Source:

DeflateStream.cs

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

public:
 override IAsyncResult ^ BeginWrite(cli::array <System::Byte> ^ buffer, int offset, int count, AsyncCallback ^ asyncCallback, System::Object ^ asyncState);

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

override this.BeginWrite : byte[] * int * int * AsyncCallback * obj -> IAsyncResult

Public Overrides Function BeginWrite (buffer As Byte(), offset As Integer, count As Integer, asyncCallback As AsyncCallback, asyncState As Object) As IAsyncResult

Parameters

buffer

Byte[]

The buffer to write data from.

offset

Int32

The byte offset to begin writing from.

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

IAsyncResult

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

Exceptions

IOException

The method tried to write asynchronously past the end of the stream, or a disk error occurred.

ArgumentException

One or more of the arguments is invalid.

ObjectDisposedException

Methods were called after the stream was closed.

NotSupportedException

The current DeflateStream implementation does not support the write operation.

InvalidOperationException

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

Remarks

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

Pass the IAsyncResult object returned by the current method to EndWrite to ensure that the write completes and frees resources appropriately. You can do this either by using the same code that called BeginWrite or in a callback passed to BeginWrite. If an error occurs during an asynchronous write operation, an exception will not be thrown until EndWrite is called with the IAsyncResult returned by this method.

If a stream is writable, writing at the end of the stream expands the stream.

The current position in the stream is updated when you issue the asynchronous read or write operation, not when the I/O operation completes. Multiple simultaneous asynchronous requests render the request completion order uncertain.

Use the CanWrite property to determine whether the current DeflateStream object supports writing.

If a stream is closed or you pass an invalid argument, exceptions are thrown immediately from BeginWrite. Errors that occur during an asynchronous write request, such as a disk failure during the I/O request, occur on the thread pool thread and throw exceptions when calling EndWrite.