IRecordSequence.Append Method (ArraySegment<Byte>, SequenceNumber, SequenceNumber, RecordAppendOptions, ReservationCollection)

 

When overridden in a derived class, appends a log record to the IRecordSequence, using space previously reserved in the sequence.

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

SequenceNumber Append(
	ArraySegment<byte> data,
	SequenceNumber nextUndoRecord,
	SequenceNumber previousRecord,
	RecordAppendOptions recordAppendOptions,
	ReservationCollection reservations
)

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.

Return Value

Type: System.IO.Log.SequenceNumber

The sequence number of the appended log record.

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

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
Available since 3.0
Return to top
Show: