IRecordSequence.Append Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
When overridden in a derived class, writes a log record to the IRecordSequence.
Overloads
| Append(ArraySegment<Byte>, SequenceNumber, SequenceNumber, RecordAppendOptions) |
When overridden in a derived class, writes a log record to the IRecordSequence. |
| Append(IList<ArraySegment<Byte>>, SequenceNumber, SequenceNumber, RecordAppendOptions) |
When overridden in a derived class, appends a log record to the IRecordSequence. |
| Append(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. |
| Append(IList<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. |
Append(ArraySegment<Byte>, SequenceNumber, SequenceNumber, RecordAppendOptions)
When overridden in a derived class, writes a log record to the IRecordSequence.
public:
System::IO::Log::SequenceNumber Append(ArraySegment<System::Byte> data, System::IO::Log::SequenceNumber nextUndoRecord, System::IO::Log::SequenceNumber previousRecord, System::IO::Log::RecordAppendOptions recordAppendOptions);public System.IO.Log.SequenceNumber Append (ArraySegment<byte> data, System.IO.Log.SequenceNumber nextUndoRecord, System.IO.Log.SequenceNumber previousRecord, System.IO.Log.RecordAppendOptions recordAppendOptions);abstract member Append : ArraySegment<byte> * System.IO.Log.SequenceNumber * System.IO.Log.SequenceNumber * System.IO.Log.RecordAppendOptions -> System.IO.Log.SequenceNumberPublic Function Append (data As ArraySegment(Of Byte), nextUndoRecord As SequenceNumber, previousRecord As SequenceNumber, recordAppendOptions As RecordAppendOptions) As SequenceNumberParameters
- data
- ArraySegment<Byte>
A list of byte array segments that will be concatenated and appended as the record.
- nextUndoRecord
- SequenceNumber
The sequence number of the next record in the user-specified order.
- previousRecord
- SequenceNumber
The sequence number of the next record in Previous order.
- recordAppendOptions
- RecordAppendOptions
A valid value of RecordAppendOptions that specifies how the data should be written.
Returns
The sequence number of the appended log record.
Exceptions
One or more of the arguments is invalid.
An I/O error occurred while appending the record.
The record sequence could not make enough free space to contain the new record.
The method was called after the sequence has been disposed of.
Remarks
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.
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.
Applies to
Append(IList<ArraySegment<Byte>>, SequenceNumber, SequenceNumber, RecordAppendOptions)
When overridden in a derived class, appends a log record to the IRecordSequence.
public:
System::IO::Log::SequenceNumber Append(System::Collections::Generic::IList<ArraySegment<System::Byte>> ^ data, System::IO::Log::SequenceNumber nextUndoRecord, System::IO::Log::SequenceNumber previousRecord, System::IO::Log::RecordAppendOptions recordAppendOptions);public System.IO.Log.SequenceNumber Append (System.Collections.Generic.IList<ArraySegment<byte>> data, System.IO.Log.SequenceNumber nextUndoRecord, System.IO.Log.SequenceNumber previousRecord, System.IO.Log.RecordAppendOptions recordAppendOptions);abstract member Append : System.Collections.Generic.IList<ArraySegment<byte>> * System.IO.Log.SequenceNumber * System.IO.Log.SequenceNumber * System.IO.Log.RecordAppendOptions -> System.IO.Log.SequenceNumberPublic Function Append (data As IList(Of ArraySegment(Of Byte)), nextUndoRecord As SequenceNumber, previousRecord As SequenceNumber, recordAppendOptions As RecordAppendOptions) As SequenceNumberParameters
- data
- IList<ArraySegment<Byte>>
A list of byte array segments that will be concatenated and appended as the record.
- nextUndoRecord
- SequenceNumber
The sequence number of the next record in the user-specified order.
- previousRecord
- SequenceNumber
The sequence number of the next record in Previous order.
- recordAppendOptions
- RecordAppendOptions
A valid value of RecordAppendOptions that specifies how the data should be written.
Returns
The sequence number of the appended log record.
Exceptions
One or more of the arguments is invalid.
An I/O error occurred while appending the record.
The record sequence could not make enough free space to contain the new record.
The method was called after the sequence has been disposed of.
Remarks
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.
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.
Applies to
Append(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.
public:
System::IO::Log::SequenceNumber Append(ArraySegment<System::Byte> data, System::IO::Log::SequenceNumber nextUndoRecord, System::IO::Log::SequenceNumber previousRecord, System::IO::Log::RecordAppendOptions recordAppendOptions, System::IO::Log::ReservationCollection ^ reservations);public System.IO.Log.SequenceNumber Append (ArraySegment<byte> data, System.IO.Log.SequenceNumber nextUndoRecord, System.IO.Log.SequenceNumber previousRecord, System.IO.Log.RecordAppendOptions recordAppendOptions, System.IO.Log.ReservationCollection reservations);abstract member Append : ArraySegment<byte> * System.IO.Log.SequenceNumber * System.IO.Log.SequenceNumber * System.IO.Log.RecordAppendOptions * System.IO.Log.ReservationCollection -> System.IO.Log.SequenceNumberPublic Function Append (data As ArraySegment(Of Byte), nextUndoRecord As SequenceNumber, previousRecord As SequenceNumber, recordAppendOptions As RecordAppendOptions, reservations As ReservationCollection) As SequenceNumberParameters
- data
- ArraySegment<Byte>
A list of byte array segments that will be concatenated and appended as the record.
- nextUndoRecord
- SequenceNumber
The sequence number of the next record in the user-specified order.
- previousRecord
- SequenceNumber
The sequence number of the next record in Previous order.
- recordAppendOptions
- RecordAppendOptions
A valid value of RecordAppendOptions that specifies how the data should be written.
- reservations
- ReservationCollection
A ReservationCollection that contains the reservation that should be used for this record.
Returns
The sequence number of the appended log record.
Exceptions
One or more of the arguments is invalid.
An I/O error occurred while appending the record.
The record sequence could not make enough free space to contain the new record.
The method was called after the sequence has been disposed of.
Remarks
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.
Applies to
Append(IList<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.
public:
System::IO::Log::SequenceNumber Append(System::Collections::Generic::IList<ArraySegment<System::Byte>> ^ data, System::IO::Log::SequenceNumber nextUndoRecord, System::IO::Log::SequenceNumber previousRecord, System::IO::Log::RecordAppendOptions recordAppendOptions, System::IO::Log::ReservationCollection ^ reservations);public System.IO.Log.SequenceNumber Append (System.Collections.Generic.IList<ArraySegment<byte>> data, System.IO.Log.SequenceNumber nextUndoRecord, System.IO.Log.SequenceNumber previousRecord, System.IO.Log.RecordAppendOptions recordAppendOptions, System.IO.Log.ReservationCollection reservations);abstract member Append : System.Collections.Generic.IList<ArraySegment<byte>> * System.IO.Log.SequenceNumber * System.IO.Log.SequenceNumber * System.IO.Log.RecordAppendOptions * System.IO.Log.ReservationCollection -> System.IO.Log.SequenceNumberPublic Function Append (data As IList(Of ArraySegment(Of Byte)), nextUndoRecord As SequenceNumber, previousRecord As SequenceNumber, recordAppendOptions As RecordAppendOptions, reservations As ReservationCollection) As SequenceNumberParameters
- data
- IList<ArraySegment<Byte>>
A list of byte array segments that will be concatenated and appended as the record.
- nextUndoRecord
- SequenceNumber
The sequence number of the next record in the user-specified order.
- previousRecord
- SequenceNumber
The sequence number of the next record in Previous order.
- recordAppendOptions
- RecordAppendOptions
A valid value of RecordAppendOptions that specifies how the data should be written.
- reservations
- ReservationCollection
A ReservationCollection that contains the reservation that should be used for this record.
Returns
The sequence number of the appended log record.
Exceptions
One or more of the arguments is invalid.
An I/O error occurred while appending the record.
The record sequence could not make enough free space to contain the new record.
The method was called after the sequence has been disposed of.
Remarks
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.
