Export (0) Print
Expand All

IRecordSequence.BeginAppend Method (ArraySegment<Byte>, SequenceNumber, SequenceNumber, RecordAppendOptions, ReservationCollection, AsyncCallback, Object)

When overridden in a derived class, begins an asynchronous append operation using space previously reserved in the sequence.

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

IAsyncResult BeginAppend(
	ArraySegment<byte> data,
	SequenceNumber nextUndoRecord,
	SequenceNumber previousRecord,
	RecordAppendOptions recordAppendOptions,
	ReservationCollection reservations,
	AsyncCallback callback,
	Object state
)

Parameters

data
Type: System.ArraySegment<Byte>

A list of byte array segments that will be concatenated and appended as the record.

nextUndoRecord
Type: System.IO.Log.SequenceNumber

The sequence number of the next record in the user-specified order.

previousRecord
Type: System.IO.Log.SequenceNumber

The sequence number of the next record in Previous order.

recordAppendOptions
Type: System.IO.Log.RecordAppendOptions

A valid value of RecordAppendOptions that specifies how the data should be written.

reservations
Type: System.IO.Log.ReservationCollection

A ReservationCollection that contains the reservation that should be used for this record.

callback
Type: System.AsyncCallback

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

state
Type: System.Object

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

Return Value

Type: System.IAsyncResult
An IAsyncResult that represents the asynchronous append, which could still be pending.

ExceptionCondition
ArgumentException

One or more of the arguments is invalid.

IOException

An I/O error occurred while appending the record.

SequenceFullException

The record sequence could not make enough free space to contain the new record.

ObjectDisposedException

The method was called after the sequence has been disposed of.

You should pass the IAsyncResult returned by this method to the EndAppend method to ensure that the append operation has completed and resources can be freed appropriately. If an error has occurred during an asynchronous append, an exception is not thrown until the EndAppend method is called with the IAsyncResult returned by this method.

Data contained in the data parameter will be concatenated into a single byte array for appending as the record. However, no provision is made for splitting data back into array segments when the record is read.

The appended record will consume space that has been previously reserved, using a reservation specified by the reservations parameter. If the append succeeds, it will consume the smallest reservation area that can hold the data, and that reservation area will be removed from the collection.

Normally, this method completes before the record has been written. To ensure that a record has been written, either specify the ForceFlush flag using the recordAppendOptions parameter, or call the Flush method.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4

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