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

 

Appends a log record to the IRecordSequence, using space previously reserved in the sequence. This method cannot be inherited.

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

public SequenceNumber Append(
	IList<ArraySegment<byte>> data,
	SequenceNumber userRecord,
	SequenceNumber previousRecord,
	RecordAppendOptions recordAppendOptions,
	ReservationCollection reservations
)

Parameters

data
Type: System.Collections.Generic.IList<ArraySegment<Byte>>

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

userRecord
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

userRecord or previousRecord is not valid for this sequence.

-or-

data cannot be appended because it is larger than the maximum record size.

-or-

reservations was not created by this record sequence.

ArgumentNullException

One or more of the arguments are null.

ArgumentOutOfRangeException

userRecord or previousRecord is not between the base and last sequence numbers of this sequence.

IOException

The request could not be performed because of an unexpected I/O exception.

-or-

The request could not be performed because of an I/O device error.

NotSupportedException

The operation cannot be performed because the record sequence was opened with read-only access.

ObjectDisposedException

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

OutOfMemoryException

There is not enough memory to continue the execution of the program.

SequenceFullException

The record sequence is full.

UnauthorizedAccessException

Access for the specified log sequence is denied by the operating system.

ReservationNotFoundException

No reservation large enough to fit data can be found in reservations.

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: