Export (0) Print
Expand All

DeflateStream::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 to write data from.

offset
Type: System::Int32

The byte offset in buffer to begin writing from.

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

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

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.

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