Export (0) Print
Expand All

GZipStream::BeginWrite Method

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)

[HostProtectionAttribute(SecurityAction::LinkDemand, ExternalThreading = true)]
public:
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.

ExceptionCondition
InvalidOperationException

The underlying stream is nullptr.

-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 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.

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: ExternalThreading. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft