LogRecordSequence.Append LogRecordSequence.Append LogRecordSequence.Append Method

Definition

Writes a log record to the IRecordSequence.

Overloads

Append(ArraySegment<Byte>, SequenceNumber, SequenceNumber, RecordAppendOptions, ReservationCollection) Append(ArraySegment<Byte>, SequenceNumber, SequenceNumber, RecordAppendOptions, ReservationCollection) Append(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.

Append(IList<ArraySegment<Byte>>, SequenceNumber, SequenceNumber, RecordAppendOptions, ReservationCollection) Append(IList<ArraySegment<Byte>>, SequenceNumber, SequenceNumber, RecordAppendOptions, ReservationCollection) Append(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.

Append(ArraySegment<Byte>, SequenceNumber, SequenceNumber, RecordAppendOptions) Append(ArraySegment<Byte>, SequenceNumber, SequenceNumber, RecordAppendOptions) Append(ArraySegment<Byte>, SequenceNumber, SequenceNumber, RecordAppendOptions)

Writes a log record to the LogRecordSequence. This method cannot be inherited.

Append(IList<ArraySegment<Byte>>, SequenceNumber, SequenceNumber, RecordAppendOptions) Append(IList<ArraySegment<Byte>>, SequenceNumber, SequenceNumber, RecordAppendOptions) Append(IList<ArraySegment<Byte>>, SequenceNumber, SequenceNumber, RecordAppendOptions)

Appends a log record to the IRecordSequence. This method cannot be inherited.

Examples

This example shows how to use the Append member

// Append records. Appending three records.  
public void AppendRecords()
{
    Console.WriteLine("Appending Log Records...");
    SequenceNumber previous = SequenceNumber.Invalid;

    previous = sequence.Append(CreateData("Hello World!"), SequenceNumber.Invalid, SequenceNumber.Invalid, RecordAppendOptions.ForceFlush);
    previous = sequence.Append(CreateData("This is my first Logging App"), SequenceNumber.Invalid, SequenceNumber.Invalid, RecordAppendOptions.ForceFlush);
    previous = sequence.Append(CreateData("Using LogRecordSequence..."), SequenceNumber.Invalid, SequenceNumber.Invalid, RecordAppendOptions.ForceFlush);

    Console.WriteLine("Done...");
}
' Append records. Appending three records.  
Public Sub AppendRecords()
	Console.WriteLine("Appending Log Records...")
	Dim previous As SequenceNumber = SequenceNumber.Invalid

	previous = sequence.Append(CreateData("Hello World!"), SequenceNumber.Invalid, SequenceNumber.Invalid, RecordAppendOptions.ForceFlush)
	previous = sequence.Append(CreateData("This is my first Logging App"), SequenceNumber.Invalid, SequenceNumber.Invalid, RecordAppendOptions.ForceFlush)
	previous = sequence.Append(CreateData("Using LogRecordSequence..."), SequenceNumber.Invalid, SequenceNumber.Invalid, RecordAppendOptions.ForceFlush)

	Console.WriteLine("Done...")
End Sub

Append(ArraySegment<Byte>, SequenceNumber, SequenceNumber, RecordAppendOptions, ReservationCollection) Append(ArraySegment<Byte>, SequenceNumber, SequenceNumber, RecordAppendOptions, ReservationCollection) Append(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.

public:
 virtual 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.SequenceNumber
override this.Append : ArraySegment<byte> * System.IO.Log.SequenceNumber * System.IO.Log.SequenceNumber * System.IO.Log.RecordAppendOptions * System.IO.Log.ReservationCollection -> System.IO.Log.SequenceNumber
Parameters
data
ArraySegment<Byte>

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

nextUndoRecord
SequenceNumber SequenceNumber SequenceNumber

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

previousRecord
SequenceNumber SequenceNumber SequenceNumber

The sequence number of the next record in Previous order.

recordAppendOptions
RecordAppendOptions RecordAppendOptions RecordAppendOptions

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

reservations
ReservationCollection ReservationCollection ReservationCollection

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

Returns

The sequence number of the appended log record.

Implements
Exceptions

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.

One or more of the arguments are null.

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

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.

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

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

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

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

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

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.

Append(IList<ArraySegment<Byte>>, SequenceNumber, SequenceNumber, RecordAppendOptions, ReservationCollection) Append(IList<ArraySegment<Byte>>, SequenceNumber, SequenceNumber, RecordAppendOptions, ReservationCollection) Append(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.

public:
 virtual System::IO::Log::SequenceNumber Append(System::Collections::Generic::IList<ArraySegment<System::Byte>> ^ data, System::IO::Log::SequenceNumber userRecord, 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 userRecord, 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.SequenceNumber
override this.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.SequenceNumber
Parameters
data
IList<ArraySegment<Byte>>

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

userRecord
SequenceNumber SequenceNumber SequenceNumber

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

previousRecord
SequenceNumber SequenceNumber SequenceNumber

The sequence number of the next record in Previous order.

recordAppendOptions
RecordAppendOptions RecordAppendOptions RecordAppendOptions

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

reservations
ReservationCollection ReservationCollection ReservationCollection

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

Returns

The sequence number of the appended log record.

Implements
Exceptions

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.

One or more of the arguments are null.

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

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.

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

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

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

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

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

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.

Append(ArraySegment<Byte>, SequenceNumber, SequenceNumber, RecordAppendOptions) Append(ArraySegment<Byte>, SequenceNumber, SequenceNumber, RecordAppendOptions) Append(ArraySegment<Byte>, SequenceNumber, SequenceNumber, RecordAppendOptions)

Writes a log record to the LogRecordSequence. This method cannot be inherited.

public:
 virtual 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.SequenceNumber
override this.Append : ArraySegment<byte> * System.IO.Log.SequenceNumber * System.IO.Log.SequenceNumber * System.IO.Log.RecordAppendOptions -> System.IO.Log.SequenceNumber
Parameters
data
ArraySegment<Byte>

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

nextUndoRecord
SequenceNumber SequenceNumber SequenceNumber

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

previousRecord
SequenceNumber SequenceNumber SequenceNumber

The sequence number of the next record in Previous order.

recordAppendOptions
RecordAppendOptions RecordAppendOptions RecordAppendOptions

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

Returns

The sequence number of the appended log record.

Implements
Exceptions

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.

One or more of the arguments are null.

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

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.

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

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

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

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

Examples

The following example demonstrates how to use this method to append a log record to the sequence.

// Start Appending in two streams with interleaving appends.

		SequenceNumber previous1 = SequenceNumber.Invalid;
		SequenceNumber previous2 = SequenceNumber.Invalid;

		Console.WriteLine("Appending interleaving records in stream1 and stream2...");
		Console.WriteLine();
// Append two records in stream1.
		previous1 = sequence1.Append(
			CreateData("MyLogStream1: Hello World!"),
			SequenceNumber.Invalid,
			SequenceNumber.Invalid,
			RecordAppendOptions.ForceFlush);
		previous1 = sequence1.Append(
			CreateData("MyLogStream1: This is my first Logging App"),
			previous1,
			previous1,
			RecordAppendOptions.ForceFlush);

// Append two records in stream2.
		previous2 = sequence2.Append(
			CreateData("MyLogStream2: Hello World!"),
			SequenceNumber.Invalid,
			SequenceNumber.Invalid,
			RecordAppendOptions.ForceFlush);
		previous2 = sequence2.Append(
			CreateData("MyLogStream2: This is my first Logging App"),
			previous2,
			previous2,
			RecordAppendOptions.ForceFlush);

// Append the third record in stream1.
		previous1 = sequence1.Append(CreateData(
			"MyLogStream1: Using LogRecordSequence..."),
			previous1,
			previous1,
			RecordAppendOptions.ForceFlush);
		
// Append the third record in stream2.
		previous2 = sequence2.Append(
			CreateData("MyLogStream2: Using LogRecordSequence..."),
			previous2,
			previous2,
			RecordAppendOptions.ForceFlush);
' Start Appending in two streams with interleaving appends.

		Dim previous1 As SequenceNumber = SequenceNumber.Invalid
		Dim previous2 As SequenceNumber = SequenceNumber.Invalid

		Console.WriteLine("Appending interleaving records in stream1 and stream2...")
		Console.WriteLine()
' Append two records in stream1.
		previous1 = sequence1.Append(CreateData("MyLogStream1: Hello World!"), SequenceNumber.Invalid, SequenceNumber.Invalid, RecordAppendOptions.ForceFlush)
		previous1 = sequence1.Append(CreateData("MyLogStream1: This is my first Logging App"), previous1, previous1, RecordAppendOptions.ForceFlush)

' Append two records in stream2.
		previous2 = sequence2.Append(CreateData("MyLogStream2: Hello World!"), SequenceNumber.Invalid, SequenceNumber.Invalid, RecordAppendOptions.ForceFlush)
		previous2 = sequence2.Append(CreateData("MyLogStream2: This is my first Logging App"), previous2, previous2, RecordAppendOptions.ForceFlush)

' Append the third record in stream1.
		previous1 = sequence1.Append(CreateData("MyLogStream1: Using LogRecordSequence..."), previous1, previous1, RecordAppendOptions.ForceFlush)

' Append the third record in stream2.
		previous2 = sequence2.Append(CreateData("MyLogStream2: Using LogRecordSequence..."), previous2, previous2, RecordAppendOptions.ForceFlush)

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.

Append(IList<ArraySegment<Byte>>, SequenceNumber, SequenceNumber, RecordAppendOptions) Append(IList<ArraySegment<Byte>>, SequenceNumber, SequenceNumber, RecordAppendOptions) Append(IList<ArraySegment<Byte>>, SequenceNumber, SequenceNumber, RecordAppendOptions)

Appends a log record to the IRecordSequence. This method cannot be inherited.

public:
 virtual System::IO::Log::SequenceNumber Append(System::Collections::Generic::IList<ArraySegment<System::Byte>> ^ data, System::IO::Log::SequenceNumber userRecord, 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 userRecord, 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.SequenceNumber
override this.Append : System.Collections.Generic.IList<ArraySegment<byte>> * System.IO.Log.SequenceNumber * System.IO.Log.SequenceNumber * System.IO.Log.RecordAppendOptions -> System.IO.Log.SequenceNumber
Parameters
data
IList<ArraySegment<Byte>>

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

userRecord
SequenceNumber SequenceNumber SequenceNumber

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

previousRecord
SequenceNumber SequenceNumber SequenceNumber

The sequence number of the next record in Previous order.

recordAppendOptions
RecordAppendOptions RecordAppendOptions RecordAppendOptions

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

Returns

The sequence number of the appended log record.

Implements
Exceptions

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.

One or more of the arguments are null.

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

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.

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

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

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

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

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