BeginWrite Method

SourceCode.IO Namespace > SizeLimitedStream Class : BeginWrite Method

Begins an asynchronous write operation. (Consider using System.IO.Stream.WriteAsync(System.Byte[],System.Int32,System.Int32) instead; see the Remarks section.)

Syntax

Visual Basic (Declaration)

Public Overrides Function BeginWrite( _
   ByVal buffer() As Byte, _
   ByVal offset As Integer, _
   ByVal count As Integer, _
   ByVal callback As AsyncCallback, _
   ByVal state As Object _
) As IAsyncResult

Visual Basic (Usage)

Dim instance As SizeLimitedStream
Dim buffer() As Byte
Dim offset As Integer
Dim count As Integer
Dim callback As AsyncCallback
Dim state As Object
Dim value As IAsyncResult
 
value = instance.BeginWrite(buffer, offset, count, callback, state)

C#

public override IAsyncResult BeginWrite( 
   byte[] buffer,
   int offset,
   int count,
   AsyncCallback callback,
   object state
)

C++/CLI

public:
IAsyncResult^ BeginWrite( 
   array<byte>^ buffer,
   int offset,
   int count,
   AsyncCallback^ callback,
   Object^ state
) override 

Parameters

buffer

The buffer to write data from.

offset

The byte offset in buffer from which to begin writing.

count

The maximum number of bytes to write.

callback

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

state

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

Return Value

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

Exceptions

Exception	Description
System.IO.IOException	Attempted an asynchronous write past the end of the stream, or a disk error occurs.
System.ArgumentException	One or more of the arguments is invalid.
System.ObjectDisposedException	Methods were called after the stream was closed.
System.NotSupportedException	The current Stream implementation does not support the write operation.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2