GZipStream::BeginWrite Method (array<Byte>^, Int32, Int32, AsyncCallback^, Object^)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Begins an asynchronous write operation. (Consider using the Stream::WriteAsync method instead; see the Remarks section.)

Namespace:   System.IO.Compression
Assembly:  System (in System.dll)

public:
[HostProtectionAttribute(SecurityAction::LinkDemand, ExternalThreading = true)]
virtual IAsyncResult^ BeginWrite(
	array<unsigned char>^ array,
	int offset,
	int count,
	AsyncCallback^ asyncCallback,
	Object^ asyncState
) override

Parameters

array
Type: array<System::Byte>^

The buffer containing data to write to the current stream.

offset
Type: System::Int32

The byte offset in array at which to begin writing.

count
Type: System::Int32

The maximum number of bytes to write.

asyncCallback
Type: System::AsyncCallback^

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

asyncState
Type: System::Object^

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

Return Value

Type: System::IAsyncResult^

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

Exception Condition
InvalidOperationException

The underlying stream is null.

-or-

The underlying stream is closed.

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 .

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.

.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Return to top
Show: